Amolith created
AGENTS.md | 1
README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 62 insertions(+)
@@ -88,6 +88,7 @@ internal/
- **Modernize**: `task modernize` (runs `modernize` which makes code
simplifications)
- **Dev**: `task dev` (runs with profiling enabled)
+- **Pre-commit flow**: `task fmt lint-fix test`
## Code Style Guidelines
@@ -1,3 +1,64 @@
+**NOTE:** This is a personal fork of
+[Crush](https://github.com/charmbracelet/crush) where I'm experimenting with
+things. You'll also find my patches merged here before they're merged into
+upstream. I've also unconditionally disabled metrics and yote the CLA; devs
+shouldn't assign their copyrights to maintainers and hand them the rug they'll
+yank from under you later.
+
+Pre-built binaries are available at
+[releases.secluded.site/crush/latest][bin-latest].
+
+[bin-latest]: https://releases.secluded.site/crush/latest
+
+- Using [mise](https://mise.jdx.dev/) (recommended), copy the snippet
+ from the releases page into your `mise.toml` or global
+`~/.config/mise/config.toml` to automate updates.
+- Without mise, or a similar tool, download the binary for your platform
+ from the releases page and place it somewhere in your `$PATH`.
+
+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
<p align="center">