From 0ec40e5ebea593a461b86ca62b0bcdde6fdb4a03 Mon Sep 17 00:00:00 2001 From: Jim Richter Date: Wed, 14 Jul 2021 19:14:25 +0200 Subject: [PATCH] feat(readme): add some info about project goal --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bd7c8a..a374512 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,33 @@ chmod +x ~/.dotfiles/setup.sh ``` ## Testing - If you want to test the script before you can run the provided docker image. ```bash docker build . -t jim-fx/dotfiles docker run -it jim-fx/dotfiles ``` + +## Opinionated Stuff + +Because this is mainly my personal configs there are some stuff which you should be aware of. + +### Directories + +- Personal projects are under ~/SYNC +- Uni projects are under ~/COCO +- Binaries are under ~/bin + +### Custom commands + +```bash +fx [s/i/o] (directory) +``` +Used to navigate and edit folders in the ~/SYNC folder + + +```bash +co [number][name] +``` + +Used to navigate and edit folders in the ~/COCO folder