diff --git a/README.md b/README.md index 9b955dd87be5b10a3992b31d8b27c2ada9451242..4a407a1ea732dbc1445fd6712c70bd961b9f0130 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -**NOTE:** This is a Crush fork where I'm experimenting with prompts and other -things. I've also ripped out the CLA. Everything below the `Crush` heading is -from the original README. To install my fork, run… +**NOTE:** This is a personal Crush (`github.com/charmbracelet/crush`) fork where +I'm experimenting with prompts and other things. You'll also find my patches +merged here before they're merged into upstream. Additionally, I've yote the +CLA; devs shouldn't assign their copyrights and hand maintainers the rug they'll +pull out from you later. + +To install my fork, run… ```sh go install git.secluded.site/crush@dev @@ -12,10 +16,39 @@ that, then merge my changes into my `dev` branch, which gets rebased on install ... @dev` might not actually fetch the latest changes through the Go module proxy. I'll try to make sure what the proxy has always compiles though. -Contributions are welcome, no need for a CLA. I'll try to keep up with -maintaining anything I accept. +Contributions are welcome (see next section below) and I'll try to keep up with +maintaining anything I accept here. + +## Collaborating on my fork + +Patch requests are on `pr.pico.sh`. You don't need a new account to contribute, +you don't need to fork this repo, you don't need to fiddle with `git +send-email`, you don't need to faff with your email client to get `git +request-pull` working... + +You just need: + +- Git +- SSH +- An SSH key + +https://pr.pico.sh/r/amolith/llm-projects + +_Short example workflow_ +```sh +# Clone this repo, make your changes, and commit them +# Create a new patch request with +git format-patch origin/main --stdout | ssh pr.pico.sh pr create amolith/llm-projects +# After potential feedback, submit a revision to an existing patch request with +git format-patch origin/main --stdout | ssh pr.pico.sh pr add {prID} +# List patch requests +ssh pr.pico.sh pr ls amolith/llm-projects +``` + +See "How do Patch Requests work?" on [pr.pico.sh]'s home page for a more +complete example workflow. -Upstream is at: https://github.com/charmbracelet/crush +_Everything from here on is from the original Crush README._ ---