diff --git a/README.md b/README.md index 92d7f0043ab9c3a929b939b9d85ef5012fa53efb..ef09bdd336ac2cf0f98ea474a9c574041b21b90d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,66 @@ +**NOTE:** This is a personal fork of +[Crush](https://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 to maintainers and hand +them the rug they'll yank from under you later. + +Install my fork either… +- Using [bin](https://github.com/marcosnils/bin) (highly recommended + because it's one tool to manage and update myriad CLI tools + distributed as statically-linked binaries, like _nasin pali_) + ```bash + bin install goinstall://git.secluded.site/crush@latest + ``` +- Or using the [go toolchain](https://go.dev/dl) (requires tracking updates + manually) + ```bash + go install git.secluded.site/crush@latest + ``` + +I pull upstream changes into the `upstream` branch here, break my +branches off that, then merge them into my `dev` branch, which gets +rebased on `upstream` fairly often. `dev` history will get rewritten +frequently. + +Contributions are welcome (see following section) and I'll try to +maintain anything I accept here. + +## Contributions + +Patch requests are in [amolith/llm-projects] 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 + +```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. + +[amolith/llm-projects]: https://pr.pico.sh/r/amolith/llm-projects +[pr.pico.sh]: https://pr.pico.sh + +--- + +_Everything from here on is from the original Crush README._ + +--- + # Crush