Skip to content

Commit 417cf6c

Browse files
committed
Clarify the two different example scripts directories in the README.md files
1 parent d0b51af commit 417cf6c

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -478,15 +478,18 @@ And our SelectOldestCapybara command is only 4 lines long as a result.
478478

479479
### Complete scripts to play with
480480

481-
There are various scripts you can play with in [example_scripts](example_scripts) that you can play with.
481+
There are various scripts in [example_scripts/shorter](example_scripts/shorter)
482+
and [example_scripts/higher_quality](example_scripts/higher_quality) that you can play with.
482483

483-
That directory also has a Gemfile if helpful for pulling in dependencies
484-
and you can use `bundle exec` there if needed.
484+
The difference between the two directories is that `higher_quality/` contains scripts that are more realistic
485+
with more descriptions and comments and `shorter/` focuses on keeping the scripts short and simple.
486+
487+
Those directories also have a Gemfile each if helpful for pulling in dependencies
488+
and so that you can use `bundle exec` there if needed.
485489

486490
## Contributing
487491

488-
Bug reports and pull requests are welcome on GitHub
489-
at https://github.com/foobara/llm-backed-command
492+
Bug reports and pull requests are welcome on GitHub at https://github.com/foobara/llm-backed-command
490493

491494
## License
492495

example_scripts/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Example scripts
2+
3+
There are various scripts in [./shorter](example_scripts/shorter) and [./higher_quality](example_scripts/higher_quality) that you can play with.
4+
5+
The difference between the two directories is that `higher_quality/` contains scripts that are more realistic
6+
with more descriptions and comments and `shorter/` focuses on keeping the scripts short and simple.
7+
8+
Those directories also have a Gemfile each if helpful for pulling in dependencies
9+
and so that you can use `bundle exec` there if needed.

0 commit comments

Comments
 (0)