flyingscorpio/setup-cockpit
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README

Browse source
This commit is contained in:
flyingscorpio@arch-desktop 2020-09-05 13:35:59 +02:00
parent 43e6e43c37
commit b83a42d178
1 changed files with 33 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -5,43 +5,48 @@ $ pip install -r requirements.txt --user
``` ```
**without** using sudo. Using sudo with pip is a bad idea because it will interfere with your distribution's package manager. **without** using sudo. Using sudo with pip is a bad idea because it will interfere with your distribution's package manager.
# About the files in the repo If on a fresh install, you won't have `pip` installed, so you'll need:
* `arch-desktop_borg.sh` ```sh
$ sudo pacman -S python-pip
```
or
```sh
$ sudo apt install python3-pip
```
Then run `./install.py`
# About the files in the repo
* `arch-desktop_borg.sh`<br>
Borg backup script. Used by a pacman hook to backup my system. Borg backup script. Used by a pacman hook to backup my system.
* `configs.yml` * `configs.yml`<br>
Lists the things to install, which includes programs, symlinks, git clones, shell commands... Lists the things to install, which includes programs, symlinks, git clones, shell commands...
* `dotfiles/` * `dotfiles/`<br>
The actual dotfiles. They are symlinked to the location that the system expects to find them. The actual dotfiles. They are symlinked to the location that the system expects to find them.
* `git_hooks/` * `git_hooks/`<br>
See `symlink_git_hooks.sh`. See `symlink_git_hooks.sh`.
* `install.py` * `install.py`<br>
Installs everything using `configs.yml`. This is the file to actually run. Installs everything using `configs.yml`. This is the file to actually run.
* `firefox_addons.txt` * `firefox_addons.txt`<br>
I like to install my Firefox add-ons manually in the Firefox add-on manager, so this file just reminds me what to install and includes the urls to each add-on. I like to install my Firefox add-ons manually in the Firefox add-on manager, so this file just reminds me what to install and includes the urls to each add-on.
* `pacman_hooks/` * `pacman_hooks/`<br>
You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it. You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it.
* `shellcheck_binary_fix.sh` * `shellcheck_binary_fix.sh`<br>
When running this on Manjaro, pacman was unable to find the shellcheck package, so this script installs the pre-compiled binary instead. If your package manager finds shellcheck, this script won't run. When running this on Manjaro, pacman was unable to find the shellcheck package, so this script installs the pre-compiled binary instead. If your package manager finds shellcheck, this script won't run.
* `symlink_git_hooks.sh` * `symlink_git_hooks.sh`<br>
Helper script to symlink any hook in `git_hooks/` to your local `.git/hooks/` folder. Only for personal use to keep my git hooks version controlled. Helper script to symlink any hook in `git_hooks/` to your local `.git/hooks/` folder. Only for personal use to keep my git hooks version controlled.
* `todo` * `todo`<br>
Never seems to remain empty... Never seems to remain empty...
# Thanks
The idea for the architecture was taken from Dimitri Merejkowsky's [GitHub](https://github.com/dmerejkowsky/dotfiles).