Update README

This commit is contained in:
Fernando Schauenburg 2024-02-08 22:28:49 +01:00
parent b9e5e9e4ea
commit 838f2de018

View file

@ -1,8 +1,10 @@
# My dotfiles My dotfiles
================================================================================
Always evolving... Always evolving...
## Quick Start Quick Start
--------------------------------------------------------------------------------
```bash ```bash
$ git clone https://github.com/fschauen/dotfiles.git $HOME/.dotfiles $ git clone https://github.com/fschauen/dotfiles.git $HOME/.dotfiles
@ -14,10 +16,11 @@ $ ./unlock.sh # decrypt the SSH configuration
If you are not me, then you won't have the password to use in the last step. If you are not me, then you won't have the password to use in the last step.
Just `git rm unlock.sh ssh/config` and add your own. Just `git rm unlock.sh ssh/config` and add your own.
## Prerequisites Prerequisites
--------------------------------------------------------------------------------
[git-crypt][] and [gpg][] are needed to decrypt sensitive information [git-crypt] and [gpg] are needed to decrypt sensitive information in the
in the repository. 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