glenux/code-preloader
1
0
Fork 0
Code Issues 19 Pull requests Projects 1 Releases Packages Wiki Activity

doc: update README with latest usage & repo

Browse source
This commit is contained in:
Glenn Y. Rolland 2023-12-29 15:58:18 +01:00
parent 206563df03
commit b8e4028d3f
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -24,7 +24,7 @@ the nature of interactions with ChatGPT.
To get started with Code-Preloader, ensure that you have Crystal language installed on your system. Follow these steps to install:
```bash
git clone https://github.com/your-repository/code-preloader.git
git clone https://code.apps.glenux.net/glenux/chatgpt-preloader
cd code-preloader
shards install
shards build
@ -36,15 +36,16 @@ Run Code-Preloader with the following command-line options:
```
Usage: code-preloader [options] ROOT_DIR
Options:
-c, --config=CONFIG_FILE Load parameters from CONFIG_FILE (not implemented yet)
-i, --ignore=IGNORE_FILE Ignore file or directory path
-o, --output=OUTPUT_FILE Write output to OUTPUT_FILE (default to stdout)
--header-prompt=HEADER_PROMPT_FILE Load header prompt from PROMPT_FILE
--footer-prompt=FOOTER_PROMPT_FILE Load footer prompt from PROMPT_FILE
--version Show version
-v, --verbose Enable verbose mode
-c CONFIG_FILE, --config=CONFIG_FILE
Load parameters from CONFIG_FILE
-i IGNORE_PATH, --ignore=IGNORE_PATH
Ignore file or directory
-o OUTPUT_FILE, --output=OUTPUT_FILE
Write output to OUTPUT_FILE
-H HEADER_PROMPT_FILE, --header-prompt=HEADER_PROMPT_FILE
Load header prompt from HEADER_PROMPT_FILE
-F FOOTER_PROMPT_FILE, --footer-prompt=FOOTER_PROMPT_FILE
Load footer prompt from FOOTER_PROMPT_FILE
-h, --help Show this help
```