Table of Contents

• About
• Features
• Used libraries
• Installation
  • Optional: Install Fonts
• Configuration
• Contributing
• License

About

This is my awesome configuration.

My goal is to make this configuration as generic and extansible as possible. Unconfigured it should give you a user experience close to the default awesome configuration.

Differnet modules can the be used to extend or change the functionality.

Features

The following features can be higlighted:

Usage

• easy configuration with reasonable defaults
• modular abstraction of keybindings

Behavior

• titlebars only for flowating clienets
• dynamic tagging
• windows-like client grouping
• layout_popup
• default or dual wibars
• hot reload of themes to change color schemes

Theme Asset

• recoloring of theme assets
• mac like titlebar buttons

(Vicious) Widgets:

• desktop popup
• wibar widgets

Used libraries

The following libraries are used:

• vicious - widget library for the wibar and desktop widgets
• revelation - Mac OSX like 'Expose' view of all clients.
• freedesktop - Freedesktop.org menu and desktop icons support.

They are included as git subtrees in the root of this repository.

Installation

This configuration requires awesome v4.3.

1. Backup your current awesome configuration

mv $HOME/.config/awesome $HOME/.config/awesome_$(date -I)

2. Clone my configuration to ~/.config/awesome/

git clone --recursive https://github.com/MArpogaus/awesome-rc.git $HOME/.config/awesome

Optional: Install Fonts

The configuration uses Font Awesome 4 for widget and tag icons and owfont for weather icons. If you want to use this functionality, make sure to install them on your system.

1. Install Font Awesome 4

# Debian / Ubuntu
apt install fonts-font-awesome
# Manjaro
pamac build ttf-font-awesome-4

2. Download and install owfont

wget -O ~/.local/share/owfont-regular.ttf 'https://github.com/websygen/owfont/blob/master/fonts/owfont-regular.ttf?raw=true'

3. Update font cache

fc-cache -v

Configuration

You can use the provided template to create your initial configuration file:

cd $HOME/.config/awesome
cp config.lua.tmpl config.lua

The configuration file config.lua defines parameters like your default applications, modkeys, the look & feel of awesome, keybindings etc. Every parameter has a reasonable fallback value defined in rc/defaults.lua. Without any configuration it should behave like the stock awesome rc.

Please refer to the wiki for details on the configuration and dont hesitate to conatct me if ther re any obscurities.

Contributing

If you have any technical issues or suggestion regarding my implementation, please feel free to either contact me, open an issue or send me a Pull Request:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Any contributions are greatly appreciated.

License

Copyright (C) 2021 Marcel Arpogaus

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.