https://github.com/timroes/awesome-config

My awesome wm configuration.
https://github.com/timroes/awesome-config

List: awesome-config

awesomewm config lua

Last synced: 2 months ago
JSON representation

My awesome wm configuration.

• Host: GitHub
• URL: https://github.com/timroes/awesome-config
• Owner: timroes
• License: mit
• Created: 2013-11-25T15:48:35.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-07-02T18:10:15.000Z (over 1 year ago)
• Last Synced: 2024-10-29T22:45:20.210Z (about 1 year ago)
• Topics: awesomewm, config, lua
• Language: Lua
• Homepage:
• Size: 2.26 MB
• Stars: 30
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Setup

=====

To install all required dependencies on an Archlinux system

just run `./install.py`. If you don't have an Archlinux system

you must make sure to install all required dependencies (have a look

at the `install.py` file) yourself.

Parts of the configuration (under `src`) is written in TypeScript and compiled

to Lua using [TypeScriptToLua](https://typescripttolua.github.io/). You can use

`yarn start` to watch for changes and compile to Lua while developing the config.

You can use `yarn build` to one-time compile the TypeScript to Lua code. This is also

called by the above mentioned `install.py` script.

Structure

=========

* **conf.d** - Contains the actual configuration read by

  `rc.lua` to setup my awesome

* **configs** - Contains several configuration files for

  external programs and a config(.sample).yml to

  configure my config slightly different on different machines

* **lib** - Contains alls modules, mainly *lunaconf* a custom

  module which includes all my widgets and utility functions which

  are used inside `conf.d`

* **scripts** - Contains some non-lua scripts, which will be called

  from within the configuration or library

* **src** - contains configurations written in TypeScript which will be compiled to Lua

* **theme** - contains the theming files configuring colors and more

* **types** - contains TypeScript definitions for awesome APIs and Lua code under `lib`