Update README
This commit is contained in:
parent
45ed3965f0
commit
0abe37c888
1 changed files with 4 additions and 21 deletions
25
README.md
25
README.md
|
@ -1,40 +1,23 @@
|
||||||
# Prerequisites
|
# 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
|
[git-crypt]: https://github.com/AGWA/git-crypt
|
||||||
[gpg]: https://gnupg.org
|
[gpg]: https://gnupg.org
|
||||||
|
|
||||||
## Install ansible on Linux
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo apt install -y ansible
|
|
||||||
```
|
|
||||||
|
|
||||||
## Install ansible on macOS
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install ansible
|
|
||||||
```
|
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
Steps:
|
Steps:
|
||||||
1. Clone the repo.
|
1. Clone the repo.
|
||||||
1. Play the `local.yml` ansible playbook.
|
|
||||||
1. Decrypt key & initialize git-crypt to access sensitive data.
|
1. Decrypt key & initialize git-crypt to access sensitive data.
|
||||||
|
1. Run `install.sh`
|
||||||
|
|
||||||
Gimme the code:
|
Gimme the code:
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.schauenburg.me/fernando/dotfiles.git $HOME/.dotfiles
|
git clone https://git.schauenburg.me/fernando/dotfiles.git $HOME/.dotfiles
|
||||||
cd $HOME/.dotfiles
|
cd $HOME/.dotfiles
|
||||||
ansible-playbook local.yml
|
|
||||||
gpg -d --output - <(base64 -d .key) | git crypt unlock -
|
gpg -d --output - <(base64 -d .key) | git crypt unlock -
|
||||||
|
./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue