feat(readme): add some info about project goal
This commit is contained in:
parent
24afcffe52
commit
0ec40e5ebe
25
README.md
25
README.md
@ -23,10 +23,33 @@ chmod +x ~/.dotfiles/setup.sh
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
If you want to test the script before you can run the provided docker image.
|
If you want to test the script before you can run the provided docker image.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build . -t jim-fx/dotfiles
|
docker build . -t jim-fx/dotfiles
|
||||||
docker run -it 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
|
||||||
|
Loading…
Reference in New Issue
Block a user