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

doc: improve wording
Some checks failed
continuous-integration/drone/push Build is failing
Details

Browse source
This commit is contained in:
Glenn Y. Rolland 2024-01-04 12:47:30 +01:00
parent a7df9a69b2
commit be4a80939b
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -121,7 +121,8 @@ result file itself:
| ctrlc
```
__Note__ `ctrlc` is my alias to `xclip -selection clipboard -i`
__Note:__ the command `ctrlc` in previous command is an alias to `xclip
-selection clipboard -i`
### Using a config file
@ -141,7 +142,12 @@ Init options:
#### Example: Advanced with configuration file
Given the following configuration file (ex: `code_preloader.yml`).
Create an empty configuration file with
```bash
./bin/code-preloader init -c .code_preloader.yml
```
Adapt the configuration file (`.code_preloader.yml`) to your needs:
```yaml
---
@ -156,13 +162,14 @@ header_prompt_file_path: prompts/context.txt
footer_prompt_file_path: prompts/request-readme.txt
```
You can type a shorter command like:
Then you can type a shorter command like:
```bash
./bin/code-preloader -c code_preloader.yml src | ctrlc
./bin/code-preloader pack -c .code_preloader.yml src | ctrlc
```
__Note__ `ctrlc` is my alias to `xclip -selection clipboard -i`
__Note:__ the command `ctrlc` in previous command is an alias to `xclip
-selection clipboard -i`
## Contributing