From 20f6774d52225e8fc0d9e48db6dc9e4491228ad4 Mon Sep 17 00:00:00 2001 From: blob42 Date: Fri, 6 Jan 2023 16:29:07 +0100 Subject: [PATCH] update readme --- README.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 05ce7f4..7f5f6ca 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,21 @@ To install the dependencies needed to run this program, run: `pip install -r requirements.txt` -You will also need to have `fzf` locally installed. +The remote and custom prompts are installed under +`$XDG_DATA_HOME/chatgpt-prompts` + +You will also need to have `fzf` locally installed. If you +don't have it already, you can install it by running: + +### Debian, Ubuntu, etc +`sudo apt install fzf` + +### CentOS, Fedora, etc +`sudo yum install fzf` + +### macOS +TODO + ## Usage @@ -19,22 +33,28 @@ To use this program, run: `cgpt.py [COMMAND]` -If no command is provided, it will present you with a list of prompts that you -can choose from. Use the up and down arrow keys to navigate the list and the -Enter key to select a prompt. +If no command is provided, it will present you with a list +of prompts that you can choose from. Use the up and down +arrow keys to navigate the list and the Enter key to +select a prompt. You can also use the following commands: -- `add`: Add a custom prompt to the list. -- `delete`: Delete a custom prompt from the list. - `update`: Update the list of prompts from the remote repository. +- `add`: Add a custom prompt to the list. + + +## Prompts Location + -## Features/TODO +## Features - [x] Update the list of prompts from the remote repository. - [x] Add support for custom prompts - [ ] Create a pull request to add custom prompts to the remote repository. +- [ ] Delete a custom prompt. +- [ ] macOS and Windows support ## Credits The prompts in this tool are taken from the [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) repository.