Skip to content

Latest commit

 

History

History
executable file
·
111 lines (79 loc) · 5.9 KB

README.md

File metadata and controls

executable file
·
111 lines (79 loc) · 5.9 KB
Raw

Material Awesome

Original work by PapyElGringo, official development has moved to material-shell

Now I am further developing this project to full extent of my abilities.

An almost desktop environment made with AwesomeWM following the Material Design guidelines with a performant opiniated mouse/keyboard workflow to increase daily productivity and comfort.

Note: Screenshot may be outdated so try and check out for your self :)

Tiled Panel Exit screen

Installation

1) Get all the dependencies

Debian-Based

sudo apt install awesome fonts-roboto rofi compton i3lock xclip qt5-style-plugins materia-gtk-theme lxappearance xbacklight scrot pnmixer ranger policykit-1-gnome grabc rofi-wifi-menu-git  -y

wget -qO- https://git.io/papirus-icon-theme-install | sh

Arch-Based

pacman -S awesome rofi=1.6.0 picom i3lock-fancy xclip ttf-roboto polkit-gnome materia-theme lxappearance scrot pnmixer qt5-styleplugins ranger papirus-icon-theme rofi-wifi-menu-git grabc -y
  • AwesomeWM as the window manager - universal package install: awesome
  • Roboto as the font - Debian: fonts-roboto Arch: ttf-roboto
  • Rofi for the app launcher - universal install: rofi
  • Picom for the compositor (blur and animations) universal install: picom
  • betterlockscreen the lockscreen application Arch Install: betterlockscreen Debian: betterlockscreen
  • Rofi-Wifi-Menu for the wifi menu, extra light and gets the job done
  • xclip for copying screenshots to clipboard package: xclip
  • Parcellite Clipboard That Manages Your Copy/Paste Content On The Go
  • gnome-keyring and a policykit-agent (by default policykit-1-gnome is enabled) OR mate-polkit
  • (Optional) qt5-styles-gtk2 or qt5-styleplugins-git for making QT and KDE applications look the same as gnome applications debian: qt5-style-plugins
  • (Optional) Materia as GTK theme - Arch Install: materia-theme debian: materia-gtk-theme
  • (Optional) Papirus Dark as icon theme Universal Install: wget -qO- https://git.io/papirus-icon-theme-install | sh
  • (Optional) lxappearance to set up the gtk and icon theme
  • (Optional) xbacklight for adjusting brightness on laptops (disabled by default)
  • (Optional) Scrot screenshot utility
  • (Optional) GrabC Color Picker Key Combination is Super + Shift + P
  • (Optional) Alacrty Default Terminal

2) Current Features

  • Material Design
  • Built-In Native Script Based Widget(wifi, weather, volume, brightness, battery etc)
  • Rofi Script based menus, instead of 3rd party applications(which consume alot of resources)
  • Keyboard Shortcut driven(Most love dedicated to Vim Keybindings)
  • Hybrid Keyboard and Mouse driven experience
  • Best of both worlds(Desktop Environment & Window Manager)

3) Future Developmental Features

  • Aim: To make window manager that relies less on 3rd party apps and has most of the things built-in natively
  • Tree Tiling: i3 Window Manager Tree Tiling Setup for Awesome.
  • Code Optimization
  • Documentation Update
  • ScreenRecorder Integeration
  • Material theme for rofi calc
  • Todo List
  • Droplet quick settings view instead of the usual sliders

4) Clone the configuration

git clone https://github.com/eqan/material-awesome.git ~/.config/awesome

Awesome 4.3 is so new that most of the distributions have not updated it yet. If you want to install this config on Awesome 4.2 (current version on depo) use the specific awesome-4.2 branch (not in development by me)

git clone -b awesome-4.2 https://github.com/PapyElGringo/material-awesome.git ~/.config/awesome

5) Set the themes

Start lxappearance to active the icon theme and GTK theme Note: for cursor theme, edit ~/.icons/default/index.theme and ~/.config/gtk3-0/settings.ini, for the change to also show up in applications run as root, copy the 2 files over to their respective place in /root.

6) Same theme for Qt/KDE applications and GTK applications, and fix missing indicators

First install qt5-style-plugins or qt5-style-gtk2 (debian) | qt5-styleplugins (arch) and add this to the bottom of your /etc/environment

XDG_CURRENT_DESKTOP=Unity
QT_QPA_PLATFORMTHEME=gtk2

The first variable fixes most indicators (especially electron based ones!), the second tells Qt and KDE applications to use your gtk2 theme set through lxappearance.

7) Read the documentation

The documentation live within the source code.

The project is split in functional directories and in each of them there is a readme where you can get additionnal informations about the them.

  • Configuration is about all the settings available
  • Layout hold the disposition of all the widgets
  • Module contain all the features available
  • Theme hold all the aestetic aspects
  • Widget contain all the widgets available