Update README

This commit is contained in:
Fernando Schauenburg 2022-09-26 21:06:39 +02:00
parent 45ed3965f0
commit 0abe37c888

View file

@ -1,40 +1,23 @@
# Prerequisites
Only [ansible][] is required for installing the dotfiles.
[git-crypt][] and [gpg][] are needed to decrypt sensitive information
in the repository.
_NOTE:_ [git-crypt][] and [gpg][] are needed to decrypt sensitive information
in the repository, but these are installed by the [ansible
playbook](local.yml).
[ansible]: https://www.ansible.com
[git-crypt]: https://github.com/AGWA/git-crypt
[gpg]: https://gnupg.org
## Install ansible on Linux
```bash
sudo apt install -y ansible
```
## Install ansible on macOS
```bash
brew install ansible
```
# Installation
Steps:
1. Clone the repo.
1. Play the `local.yml` ansible playbook.
1. Decrypt key & initialize git-crypt to access sensitive data.
1. Run `install.sh`
Gimme the code:
```bash
git clone https://git.schauenburg.me/fernando/dotfiles.git $HOME/.dotfiles
cd $HOME/.dotfiles
ansible-playbook local.yml
gpg -d --output - <(base64 -d .key) | git crypt unlock -
./install.sh
```