From 45f8a651f2293b39f97eae4641978f645040cc68 Mon Sep 17 00:00:00 2001 From: Ayo Date: Fri, 27 Jun 2025 15:19:22 +0200 Subject: [PATCH] chore: update set up instructions --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 77aa332..e29207d 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,24 @@ $ vim ~/ayo.conf 3\. update your .bashrc to add an alias for the parent command `scripts/ayo.sh` -## Dependencies -1. Typora - used as default editor for notes +## Set up + +1\. Clone repo +``` bash +# By default this should be inside ~/Projects/ directory +# otherwise, you have to update the config in the next step +$ git clone git@git.sr.ht:~ayoayco/scripts +$ cd scripts +``` + +2\. Copy config (and update values as needed!) +``` bash +$ cp example.conf ~/ayo.conf +``` + +3\. Install some dependencies +1. [Typora](https://typora.io) - used as an alternative editor for notes (using flag `-t`) +1. `timeout` - install on mac via coreutils: `brew install coreutils` ## Scripts