docs: add fork section

Amolith and Crush created 3 months ago

Co-Authored-By: Crush <[e-mail]>

Change summary

CRUSH.md  |  1 
README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 65 insertions(+)

Detailed changes

CRUSH.md

@@ -9,6 +9,7 @@
 - **Lint**: `task lint:fix`
 - **Format**: `task fmt` (gofumpt -w .)
 - **Dev**: `task dev` (runs with profiling enabled)
+- **Pre-commit flow**: `task fmt lint-fix test`
 
 ## Code Style Guidelines
 

README.md

@@ -1,3 +1,67 @@
+**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.
+
+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@v0.30.1-fork.1
+  ```
+- Or using the [go toolchain](https://go.dev/dl) (requires tracking updates
+  manually)
+  ```bash
+  go install git.secluded.site/crush@v0.30.1-fork.1
+  ```
+
+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">