Update README

This commit is contained in:
Fernando Schauenburg 2022-12-12 21:14:16 +01:00
parent dad81aecb5
commit 690e12059d

View file

@ -1,4 +1,16 @@
# Prerequisites # My dotfiles
Always evolving...
## Quick Start
```bash
git clone https://git.schauenburg.me/fernando/dotfiles.git $HOME/.dotfiles
cd $HOME/.dotfiles
gpg -d --output - <(base64 -d .key) | git crypt unlock -
./install.sh
```
## Prerequisites
[git-crypt][] and [gpg][] are needed to decrypt sensitive information [git-crypt][] and [gpg][] are needed to decrypt sensitive information
in the repository. in the repository.
@ -6,18 +18,3 @@ in the repository.
[git-crypt]: https://github.com/AGWA/git-crypt [git-crypt]: https://github.com/AGWA/git-crypt
[gpg]: https://gnupg.org [gpg]: https://gnupg.org
# Installation
Steps:
1. Clone the repo.
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
gpg -d --output - <(base64 -d .key) | git crypt unlock -
./install.sh
```