An open API service indexing awesome lists of open source software.

https://github.com/antomfdez/riverdots

An awesome dotfiles to get a fast and customizable river compositor setup!
https://github.com/antomfdez/riverdots

arch linux river shell twm

Last synced: 5 months ago
JSON representation

An awesome dotfiles to get a fast and customizable river compositor setup!

Awesome Lists containing this project

README

          





Logo

RiverDots


An awesome dotfiles to get a fast and customizable river compositor setup!




View Demo
·
Report Bug
·
Request Feature


Table of Contents



  1. About The Project


  2. Getting Started


  3. Usage

  4. Contributing

  5. License

  6. Contact

## About The Project

![Screen Shot](https://github.com/antomfdez/RiverDots/blob/main/repo-assets/screenshot.png)


![Screen Shot2](https://github.com/antomfdez/RiverDots/blob/main/repo-assets/screenshot2.png)


![Screen Shot3](https://github.com/antomfdez/RiverDots/blob/main/repo-assets/screenshot3.png)

Level up your dev setup with my custom dotfiles and easy-to-use installer. Save time, stay organized, and boost your productivity. Give your workflow the upgrade it deserves!

- My dotfiles streamline your development environment, automating the tedious tasks and freeing up your time for innovation.

- Why waste time on the mundane when you can focus on what truly matters?
Let my installer handle the heavy lifting, so you can spend more time building extraordinary things.

(back to top)

## Getting Started

Built for a clean Arch Linux install, but can be tweaked for your existing system.

### Installation

_Run the `install.sh` in a fresh Arch Linux install._ (Connect to internet first!)

1. Clone the repo:
```bash
git clone https://github.com/antomfdez/RiverDots.git
```
2. Move to RiverDots directory:
```bash
cd RiverDots
```
3. Execute the installer:
```bash
chmod +x install.sh
./install.sh
```

(back to top)

## Usage

***Keys:***
```
Modkey = Super, Windows

Mod T, open terminal
Mod Q, close window
Mod R, open app launcher

Mod l, increase width
Mod h, decrease width
Mod j, move to previous window
Mod k, move to next window

Mod 1,2,3,4,5,6,7,8,9, switch to workspace
Mod+Shift 1,2,3,4,5,6,7,8,9, move window to workspace

Mod Up, change layout to main window up
Mod Down, change layout to main window down
Mod Right, change layout to main window right
Mod Left, change layout to main window reft

Alt+Shift Up, volume up +5%
Alt+Shift Down, volume down -5%
```

***Scripts:***
- `~/scripts/update-wall.sh`: change the wallpaper _(it's permanent against reboots)_
```
~/scripts/update-wall.sh
```

_Oficial river wiki -> (https://codeberg.org/river/wiki)_

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

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

## License

Distributed under the MIT License. See [LICENSE](https://github.com/antomfdez/RiverDots/blob/main/LICENSE) for more information.

(back to top)

## Contact

X.com - [@AntomFdez](https://x.com/AntomFdez)

Project Link: [https://github.com/antomfdez/RiverDots](https://github.com/antomfdez/RiverDots)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/antomfdez/RiverDots/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/antomfdez/RiverDots/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/antomfdez/RiverDots/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/antomfdez/RiverDots/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/antomfdez/RiverDots/blob/main/LICENSE
[product-screenshot]: repo-assets/screenshot.png