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

Update README.md

This commit is contained in:
Santiago Lo Coco 2022-01-19 16:07:45 -03:00 committed by GitHub
parent 2d13f1d0e9
commit 22542bc103
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,11 +1,10 @@
# dotfiles
Backup all your dotfiles (and easily deploy them on another machine).
Personal dotfiles saved and deployed using [sadedot][3].
## Table of contents
- [Installation <a name="installation"></a>](#installation-)
- [Usage <a name="usage"></a>](#usage-)
- [Dependencies <a name="dependencies"></a>](#dependencies-)
- [Contributing <a name="contributing"></a>](#contributing-)
- [License <a name="license"></a>](#license-)
@ -15,7 +14,7 @@ Backup all your dotfiles (and easily deploy them on another machine).
## Usage <a name="usage"></a>
You have to move all your dotfiles to the dotfiles folder and then the script will do the symbolic links. Doing it this way, you can now upload them to your repository (to have a backup of them).
You have to move all your dotfiles to the dotfiles folder and then the `sadedot` scripts will do the symbolic links. Doing it this way, you can now upload them to your repository (to have a backup of them).
You should note that all 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].
@ -25,24 +24,7 @@ So, to run the script:
sh sadedot/scripts/bootstrap.sh
```
By default the script will run with whiptail (`libnewt`).
However, the script can use both `dialog` and `whiptail` as a way to display dialog boxes, so if you want to use dialog you have to pass `-d` as a parameter.
For example, you can run
```bash
sh sadedot/scripts/bootstrap.sh -d
```
to use dialog.
Finally, you can run the script with `-l` if you want to print the log in the `sadedot.log` file.
Note that you can modify the `sadedot/scripts/install.sh` if you want to install some programs on your machine when this script is run. By default, `sadedot/scripts/bootstrap.sh` will not run this script, so you will need to use the `-p` flag if you want it to run `sadedot/scripts/install.sh` (it will run at the end of the `scripts/bootstrap.sh` script).
## Dependencies <a name="dependencies"></a>
You must install `libnewt` or `dialog`.
You can modify the `sadedot/scripts/install.sh` if you want to install some programs on your machine when this script is run. By default, `sadedot/scripts/bootstrap.sh` will not run this script, so you will need to use the `-p` flag if you want it to run `sadedot/scripts/install.sh` (it will run at the end of the script).
## Updating
@ -56,7 +38,9 @@ sh sadedot/scripts/update.sh
PRs are welcome.
## License <a name="license"></a>
[MIT](https://choosealicense.com/licenses/mit/)
[MIT](https://raw.githubusercontent.com/santilococo/dotfiles/master/LICENSE.md)
[1]: https://github.com/santilococo/dotfiles/fork
[2]: https://github.com/santilococo/dotfiles/tree/master/dotfiles/other
[3]: https://github.com/santilococo/sadedot