From 7903b1d51a2901462a1c13a38c4bea66055b3406 Mon Sep 17 00:00:00 2001 From: Yigid BALABAN Date: Wed, 3 Jul 2024 01:29:18 +0300 Subject: [PATCH] Initial commit --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8b7b04 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# reve + +Build your own desktop environment around a single script, with reve. + +_(bash not included)_ + +## Get started with reve + +1. Install reve by executing `install.sh` +2. Copy default mode-based chores from folder `chores/mode` or write your own using `examples/chore_script.sh` +3. Add reve installation folder to $PATH +4. Add a command to your window manager's configuration to call reve on launch +5. Set up a timer to call reve + +## Details + +- The installation script creates folder `reve` in `~/.local/bin/reve` and copies reve.sh as "reve" there. +- reve follows two principles: modularity and low resource use. + +## Credits + +Feel free to contact me for collaboration on anything! + +Ferit Yiğit BALABAN, <[fyb@fybx.dev][llmail]> + +[My Website][llwebsite] • [My Bento][llbento] • [X][llx] • [LinkedIn][lllinkedin] + +2024 + +[llmail]: mailto:fyb@fybx.dev +[llwebsite]: https://fybx.dev +[llbento]: https://bento.me/balaban +[llx]: https://x.com/fybalaban +[lllinkedin]: https://linkedin.com/in/fybx