From 2bd7cd88d5f22d047a9811404cce50c9c31794bb Mon Sep 17 00:00:00 2001 From: Jonathan Dunn Date: Wed, 13 Mar 2024 15:02:01 -0400 Subject: [PATCH] updated readme --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 83a6c63..4006814 100644 --- a/README.md +++ b/README.md @@ -148,40 +148,35 @@ git clone https://github.com/danielmiessler/fabric.git cd fabric ``` -4. Ensure the `setup.sh` script is executable. If you're not sure, you can make it executable by running the following command: +4. install pipx: + +Mac: ```bash -chmod +x setup.sh +brew install pipx ``` -5. Install poetry - -ref.: https://python-poetry.org/docs/#installing-with-the-official-installer +Linux: ```bash -curl -sSL https://install.python-poetry.org | python3 - +sudo apt intall pipx ``` -6. Run the `setup.sh`, which will do the following: - -- Installs python dependencies. -- Creates aliases in your OS. It should update `~/.bashrc`, `/.zshrc`, and `~/.bash_profile` if they are present in your file system. +5. Install fabric ```bash -./setup.sh +pipx install . ``` -7. Restart your shell to reload everything. - -8. Set your `OPENAI_API_KEY`. +6. Run setup: ```bash fabric --setup ``` -You'll be asked to enter your OpenAI API key, which will be written to `~/.config/fabric/.env`. Patterns will then be downloaded from Github, which will take a few moments. +7. Restart your shell to reload everything. -9. Now you are up and running! You can test by pulling the help. +8. Now you are up and running! You can test by pulling the help. ```bash # Making sure the paths are set up correctly