update readme

master
blob42 1 year ago
parent 04d7c7799e
commit 20f6774d52

@ -11,7 +11,21 @@ To install the dependencies needed to run this program, run:
`pip install -r requirements.txt` `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 ## Usage
@ -19,22 +33,28 @@ To use this program, run:
`cgpt.py [COMMAND]` `cgpt.py [COMMAND]`
If no command is provided, it will present you with a list of prompts that you If no command is provided, it will present you with a list
can choose from. Use the up and down arrow keys to navigate the list and the of prompts that you can choose from. Use the up and down
Enter key to select a prompt. arrow keys to navigate the list and the Enter key to
select a prompt.
You can also use the following commands: 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. - `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] Update the list of prompts from the remote repository.
- [x] Add support for custom prompts - [x] Add support for custom prompts
- [ ] Create a pull request to add custom prompts to the - [ ] Create a pull request to add custom prompts to the
remote repository. remote repository.
- [ ] Delete a custom prompt.
- [ ] macOS and Windows support
## Credits ## Credits
The prompts in this tool are taken from the [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) repository. The prompts in this tool are taken from the [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) repository.

Loading…
Cancel
Save