slococo
/
sadedot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Santiago Lo Coco 2023-08-18 11:23:55 +00:00
parent 9b1b824800
commit 093631f5b7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -15,15 +15,15 @@ Backup all your dotfiles (and easily deploy them on another machine).
This repo is supposed to be used as a submodule. So, if you already have a git repo with your dotfiles: This repo is supposed to be used as a submodule. So, if you already have a git repo with your dotfiles:
```bash ```bash
git submodule add git@github.com:santilococo/sadedot.git git submodule add git@gcodeberg.org:slococo/sadedot.git
git submodule update --init git submodule update --init
``` ```
And if you don't, you can [fork][1] my dotfiles repo on github. And if you don't, you can [fork][1] my dotfiles repo on git.
## Usage <a name="usage"></a> ## Usage <a name="usage"></a>
You have to move all your dotfiles to a folder named `dotfiles` (see [my repo][3] for an example) and then the script will do the symbolic links. Doing it this way, you can now push them to your github repo (so you have a backup of them). You have to move all your dotfiles to a folder named `dotfiles` (see [my repo][3] for an example) and then the script will do the symbolic links. Doing it this way, you can now push them to your git repo (so you have a backup of them).
You should note that all of these dotfiles (files or folders) will be symlinked in `$HOME`. So, if you want to symlink, for example, something in `/etc`, you have to put it in the `dotfiles/other` folder. Here you have to be careful as they will be installed in `/`. You can see an example [here][2]. You should note that all of these dotfiles (files or folders) will be symlinked in `$HOME`. So, if you want to symlink, for example, something in `/etc`, you have to put it in the `dotfiles/other` folder. Here you have to be careful as they will be installed in `/`. You can see an example [here][2].
@ -68,8 +68,8 @@ git submodule foreach git pull
PRs are welcome. PRs are welcome.
## License <a name="license"></a> ## License <a name="license"></a>
[MIT](https://raw.githubusercontent.com/santilococo/sadedot/master/LICENSE.md) [MIT](https://codeberg.org/slococo/sadedot/raw/branch/master/README.md)
[1]: https://github.com/santilococo/cdotfis/fork [1]: https://codeberg.org/slococo/cdotfis/fork
[2]: https://github.com/santilococo/cdotfis/tree/master/dotfiles/other [2]: https://codeberg.org/slococo/cdotfis/tree/master/dotfiles/other
[3]: https://github.com/santilococo/cdotfis [3]: https://codeberg.org/slococo/cdotfis