From b986545541a74a72f2c16b5e853ed66d8e064a86 Mon Sep 17 00:00:00 2001 From: Amolith Date: Thu, 30 Oct 2025 07:01:14 -0600 Subject: [PATCH] docs: polish --- README.md | 47 +++++++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ca118e9f5ead7a00c3f94f84da694c96a461317c..7b1639ff63c4784ff7c814702e8564e42cbcee59 100644 --- a/README.md +++ b/README.md @@ -11,29 +11,36 @@ SPDX-License-Identifier: CC0-1.0 _Upgrade your coding tool's todo system_ -The software this README describes exists on the `dev` branch, but requires some -testing and polish before I'm willing to merge it into main and cut a "real" -release. +The software this README describes exists in the `dev` branch, but requires +some testing and polish before I'm willing to merge it into `main` and cut a +"real" release. ## Usage -This section is first to entice you with _nasin pali_'s simplicity; after -installing the binary and prompt, having your coding tool using a better -planning system just requires typing six (or fewer!) characters. +This section is first to entice you with _nasin pali_'s simplicity; +after installing [the binary](#the-binary) and [prompt](#the-prompt), +having your coding tool use a better planning system (or any planning +system at all if you use [Crush](https://git.secluded.site/crush)) just +requires typing six characters max. -- When asking the model to do something a bit more complex, just append the +- When asking the model to do something a bit more complex, append the phrase `use np` - - If you want the model to `use np` _all_ the time, adjust the prompt after - pasting to say something like _always use `np` instead of any other todo - tools_. -- Once implemented, the `monitor` subcommand will show the model's plan and its - realtime progress and the `export` subcommand will export the rendered plan - and event log as Markdown. Should the model mark tasks failed/cancelled or - change the goal/task content, it's required to provide a reason. + - If you want the model to `use np` _all_ the time, adjust the prompt + after pasting to say something like _always use `np` instead of any + other todo tools_. + +**NOTE:** _nasin pali_ is not meant to replace your existing ticket +tracker. Keep using GitHub issues or [todo.sr.ht](https://todo.sr.ht) or +[git-bug](https://github.com/git-bug/git-bug) or whatever else. _nasin +pali_ instructs your model to record the issue reference (as well as any +file references) so you can easily resume the session in a new context +window without having to provide all the information again. ## Installation -You need both the binary and the prompt. +You need both the binary and the prompt. If you don't have the binary +when the model tries to start a session, it's instructed to ask you to +install it using the appropriate command. ### The binary @@ -51,17 +58,17 @@ You need both the binary and the prompt. ### The prompt -Paste this into some section of your `~/.config/AGENTS.md` or -`~/.claude/CLAUDE.md` or whatever titled something like `## nasin pali (the way -of work)`. +Paste this snippet into some section of your `~/.config/AGENTS.md` or +`~/.claude/CLAUDE.md` or whatever titled something like `## nasin pali +(the way of work)`. - Using `bin` ```markdown - IMPORTANT: If I ask you to `use np` or `use nasin pali` or some variation, you must completely ignore your built-in TODO tools and exclusively use what `np` provides. Try to use it, but if it's not in my PATH, ask me to install it with `bin install goinstall://git.secluded.site/np@latest`. If I've ask you to use it, start a session with `np s` and it'll guide you from there. If I haven't asked you to use it, proceed normally. + IMPORTANT: If I ask you to `use np` or `use nasin pali` or some variation, you must completely ignore your built-in TODO tools and exclusively use what `np` provides. Try to use it directly, but if it's reported unavailable or not in my PATH, ask me to install it with `bin install goinstall://git.secluded.site/np@latest`. If I've ask you to use it, start a session with `np s`. If I haven't asked you to use it, proceed normally. ``` - Using `go install` ```markdown - IMPORTANT: If I ask you to `use np` or `use nasin pali` or some variation, you must completely ignore your built-in TODO tools and exclusively use what `np` provides. Try to use it, but if it's not in my PATH, ask me to install it with `go install git.secluded.site/np@latest`. If I've ask you to use it, start a session with `np s` and it'll guide you from there. If I haven't asked you to use it, proceed normally. + IMPORTANT: If I ask you to `use np` or `use nasin pali` or some variation, you must completely ignore your built-in TODO tools and exclusively use what `np` provides. Try to use it directly, but if it's reported unavailable or not in my PATH, ask me to install it with `go install git.secluded.site/np@latest`. If I've ask you to use it, start a session with `np s`. If I haven't asked you to use it, proceed normally. ``` ---