AwesomeFiles/.github/README.md
2022-03-10 14:24:38 +07:00

109 lines
3 KiB
Markdown

<!-- Screenshot -->
<div align="center">
<img src="https://awesomewm.org/images/awesome-logo.svg">
</div>
<br>
<div align="center">
<img src="assets/awesome.png">
</div>
<br>
<br>
<!-- SETUP -->
<a href="https://awesomewm.org/"><img alt="AwesomeWM Logo" height="160" align = "left" src="https://awesomewm.org/doc/api/images/AUTOGEN_wibox_logo_logo_and_name.svg"></a>
<b> ~ AwesomeWM dotfiles ~ </b>
Welcome to my AwesomeWM Dotfiles! so yeah now i'm using awesomewm, looks like i'll be use this wm forever.
Still quite messy, because i'm still learning Lua.
Fyi, I use night colorscheme, and it's so beautiful.
<h2></h2><br>
**Here are some details about my setup:**
| Programs | Using |
| ---------- | ----------------- |
| WM | awesome |
| OS | arch linux |
| Terminal | alacritty |
| Editor | neovim / vscode |
| Compositor | picom |
| Launcher | rofi |
### Here are the instructions you should follow to replicate my AwesomeWM setup.
<details open>
<summary><strong>S E T U P</strong></summary>
1. Install dependencies
+ Dependencies
- **Arch Linux** (and all Arch-based distributions)
*Assuming your AUR helper is* `yay`
```shell
$ yay -S awesome-git picom-jonaburg-fix alacritty rofi todo-bin \
acpi acpid acpi_call jq inotify-tools polkit-gnome xdotool xclip maim colord \
brightnessctl alsa-utils alsa-tools pulseaudio pulseaudio-alsa playerctl --needed
```
2. Install needed fonts
You will need to install a few fonts (mainly icon fonts) in order for text and icons to be rendered properly.
Necessary fonts:
+ **Iosevka** - [here](https://github.com/be5invis/Iosevka)
+ **Icomoon** - [here](https://www.dropbox.com/s/hrkub2yo9iapljz/icomoon.zip?dl=0)
+ **Material** - [here](https://github.com/google/material-design-icons)
Once you download them and unpack them, place them into `~/.fonts` or `~/.local/share/fonts`.
3. Install my AwesomeWM configuration files
> Clone this repository
```shell
$ git clone https://github.com/rxyhn/AwesomeWM-Dotfiles.git
$ cd AwesomeWM-Dotfiles
```
> Copy config and binaries files
```shell
$ mkdir -p $HOME/.config/ && cp -r ./config/* $HOME/.config/
$ mkdir -p $HOME/.local/bin/ && cp -r ./bin/* $HOME/.local/bin/
$ cp -r ./misc/. $HOME/
```
4. Lastly, log out from your current desktop session and log in into AwesomeWM.
</details>
<br>
## Acknowledgements
- **Special thanks to**
+ [ner0z](https://github.com/ner0z)
+ [JavaCafe01](https://github.com/JavaCafe01)
- **Contributors**
<a href="https://github.com/rxyhn/AwesomeWM-Dotfiles/graphs/contributors">
<img src="assets/contributors.png">
</a>
<br>
<br>
<p align="center"><a href="https://github.com/rxyhn/AwesomeWM-Dotfiles/blob/main/.github/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=GPL-3.0&logoColor=eceff4&logo=github&colorA=061115&colorB=67AFC1"/></a></p>