Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arminveres/awesome
awesome window manager: Fork with LuaJIT
https://github.com/arminveres/awesome
List: awesome
awesomewm luajit
Last synced: 3 months ago
JSON representation
awesome window manager: Fork with LuaJIT
- Host: GitHub
- URL: https://github.com/arminveres/awesome
- Owner: arminveres
- License: gpl-2.0
- Fork: true (awesomeWM/awesome)
- Created: 2023-05-01T10:54:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-24T15:50:03.000Z (10 months ago)
- Last Synced: 2024-09-22T20:30:59.496Z (3 months ago)
- Topics: awesomewm, luajit
- Language: Lua
- Homepage: https://awesomewm.org/
- Size: 16.1 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Readme
## About Awesome
Awesome is a highly configurable, next generation framework window manager for X.
## Building and installation
After extracting the dist tarball or cloning the repository, run:
```sh
make
sudo make install
```
This will
1. create a build directory at `./build`,
2. run `cmake`,
3. build Awesome and
4. install it to the default prefix path `/usr/local`.
Alternatively to the above, you can generate a `.deb` or `.rpm` package, for easy installation management:
```sh
make package
sudo dpkg -i awesome-x.y.z.deb
# or
sudo rpm -Uvh awesome-x.y.z.rpm
```
### Advanced options and testing
A full list of dependencies, more advanced build options, as well as instructions on how to use the test suite can be found [here](https://awesomewm.org/apidoc/documentation/10-building-and-testing.md.html).
### Installing current git master as a package receipts
#### Arch Linux AUR
```sh
sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/awesome-git.git
cd awesome-git
makepkg -fsri
```
#### Debian-based
```sh
sudo apt build-dep awesome
git clone https://github.com/awesomewm/awesome
cd awesome
make package
cd build
sudo apt install ./*.deb
```
## Running Awesome
You can directly select Awesome from your display manager. If not, you can
add the following line to your `.xinitrc` to start Awesome using `startx`
or to `.xsession` to start Awesome using your display manager:
```sh
exec awesome
```
In order to connect Awesome to a specific display, make sure that
the `DISPLAY` environment variable is set correctly, e.g.:
```sh
DISPLAY=foo.bar:1 exec awesome
```
(This will start Awesome on display `:1` of the host foo.bar.)
## Configuration
The configuration of Awesome is done by creating a
`$XDG_CONFIG_HOME/awesome/rc.lua` file, typically `~/.config/awesome/rc.lua`.
An example configuration named `awesomerc.lua` is provided in the source.
## Troubleshooting
On most systems any message printed by Awesome (including warnings and errors)
is written to `~/.xsession-errors`.
If Awesome does not start or the configuration file is not producing the
desired results the user should examine this file to gain insight into the
problem.
### Debugging tips
You can call `awesome` with `gdb` like this:
```sh
DISPLAY=:2 gdb awesome
```
Then in `gdb` set any arguments and run it:
```
(gdb) set args --replace
(gdb) run
```
## Asking questions
#### IRC
You can join us in the `#awesome` channel on the [OFTC](http://www.oftc.net/) IRC network.
[IRC Webchat](https://webchat.oftc.net/?channels=awesome)
#### Stack Overflow
You can ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/awesome-wm).
#### Reddit
We also have an [awesome subreddit](https://www.reddit.com/r/awesomewm/) where you can share your work and ask questions.
## Reporting issues
Please report any issues you may find on [our bugtracker](https://github.com/awesomeWM/awesome/issues).
## Contributing code
You can submit pull requests on the [GitHub repository](https://github.com/awesomeWM/awesome).
Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) for any coding, documentation or patch guidelines.
## Status
[](https://travis-ci.com/awesomeWM/awesome)
## Documentation
Online documentation is available [here](https://awesomewm.org/apidoc/).
## License
The project is licensed under GNU General Public License v2 or later.
You can read it online at ([v2](http://www.gnu.org/licenses/gpl-2.0.html)
or [v3](http://www.gnu.org/licenses/gpl.html)).