feat(readme): add some info about project goal

This commit is contained in:
max_richter 2021-07-14 19:14:25 +02:00
parent 24afcffe52
commit 0ec40e5ebe

View File

@ -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