summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2025-11-08 15:40:45 +0100
committerAhmed Abdelhalim <[email protected]>2025-11-08 15:40:45 +0100
commita1383359e02dd1fed6ebe466e78397abb42c35bc (patch)
treeb2257d70cc65579eb2a3932b5be957dd939f7bca /README.md
parentcecf1905fe2dc827ae66955161415bd2a5ae34f4 (diff)
Clean up readmes
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 41 insertions, 2 deletions
diff --git a/README.md b/README.md
index d8f4518..0f6d95e 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,46 @@
# RC: [RUNCOM](https://en.wikipedia.org/wiki/RUNCOM)
-Various RC configurations for different distros:
+## Installation
+
+### Prerequisites
+
+- stow
+- homebrew (on MacOS)
+
+### Essentials
+
+```bash
+git clone https://git.sr.ht/~a14m/.rc
+cd ~/.rc
+stow --no-folding .
+git remote set-url origin [email protected]:~a14m/.rc
+```
+
+Extra configurations for different distro families:
- [MacOS](./MacOS.md)<br>
-- [TailOS](./TailOS.md)<br>
- [Debian](./Debian.md)<br>
+
+### Complementary tools
+
+#### Setup password store
+
+```bash
+git clone [email protected]:a14m/.pass ~/.password-store
+```
+
+#### [vim](https://git.sr.ht/~a14m/.vim)
+
+```bash
+git clone [email protected]:~a14m/.vim ~/.vim
+ln -sf ~/.vim/.vimrc ~/.vimrc
+vim +PlugInstall
+```
+
+#### Git Crypt
+
+```bash
+brew install git-crypt
+cd ~/.rc
+git-crypt unlock
+```