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

Correct the file explanations

Browse source
This commit is contained in:
flyingscorpio@arch-desktop 2021-03-05 20:11:10 +01:00
parent 0844ff3799
commit 1d84ae7e14
1 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -5,7 +5,7 @@ $ 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.
If on a fresh install, you won't have `pip` installed, so you'll need: If you're on a fresh install, you won't have `pip` installed, so you'll need:
```sh ```sh
$ sudo pacman -S python-pip $ sudo pacman -S python-pip
``` ```
@ -22,30 +22,43 @@ Modify the resulting file, and then run `./install.py` with needed flags (`./ins
# About the files in the repo # About the files in the repo
* `arch-desktop_borg.sh`<br> * `borg_backup.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, but it can also be run manually.
* `configs.yml`<br> * `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/`<br> * `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.
* `install.py`<br>
Installs everything using `configs.yml`. This is the file to actually run.
* `firefox_addons.txt`<br> * `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/`<br> * `install.py`<br>
You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it. Installs everything using `configs.yml`.
This is the file to actually run.
* `secrets.template`<br>
Contains environment variables for authentication and personnalization.
Use it to create a file named `secrets`.
* `shellcheck_binary_fix.sh`<br> * `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 ARM, pacman there was no shellcheck package, so this script installs the pre-compiled binary instead.
If your package manager finds shellcheck, this script won't run.
* `todo`<br> * `todo`<br>
Never seems to remain empty... Never seems to remain empty...
# YML commands
The yml `configs.yml` file contains instructions as keys, which trigger commands.
Here is a brief explanation of the implemented commands:
* `clone`<br>
Performs a `git clone`.
# Thanks # Thanks
The idea for the architecture was taken from Dimitri Merejkowsky's [GitHub](https://github.com/dmerejkowsky/dotfiles). The idea for the architecture was taken from Dimitri Merejkowsky's [GitHub](https://github.com/dmerejkowsky/dotfiles).