diff --git a/README.md b/README.md index 92f814d3..30ab32d6 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,26 @@ citizen][3]** as a single static binary that composes with pipes, respects your shell, and stays out of your way; **[extensible][4]** through sandboxed plugins; **[configurable][5]** where it matters; and finally, **[open-source and independent][6]**, holding no allegiance to any LLM provider, funded without the -enshittification of VC money, just striving to be great — thanks to and for its -users. +enshittification of VC money, and just striving to be great — thanks to and for +its users. When you adapt your programming tooling and workflow to JP, you are ensuring that you will have access to all of the frontier models, all of the local-first open source inference runtimes, and all of the major inference aggregation services. +## Architecture / Tool Calling + +JP's architecture routes to explicitly configured helper binaries as its list of +tools the LLM may call upon. +The current self-dev configuration uses a sub-project, `jp-tools`, (invoked +through the justfile) to satisfy all the binaries required for understanding +code, modifying files, interacting with version control, generating RFDs +covering new features, filing Github issues, and making selected shell +operations. +JP does not need any tools to operate, but you will want at least a subset of +the `jp-tools` collection for your valid developer configuration. + ## Getting Started JP is in active development. @@ -69,6 +81,13 @@ List and select conversations: % jp conversation use ``` +Install `jp-tools` from a local clone: + +```sh +git clone https://github.com/dcdpr/jp.git +cargo install --locked --path jp/.config/jp/tools +``` + Configure your JP workspace: ```sh @@ -81,6 +100,15 @@ See what else you can do: % jp help ``` +## Roadmap + +JP's direction is planned in the open through Requests for Discussion (RFDs), +short design documents that precede any significant change. +The RFD index ([on the web][rfds via web] / [in this repo][rfds local]) is the +canonical, always-current view of what's proposed, in progress, and decided. +If you want to understand where JP is headed or influence where it goes next, +start there. + [1]: docs/README/providers.md [2]: docs/README/privacy-and-security.md [3]: docs/README/workflow-integration.md @@ -89,3 +117,5 @@ See what else you can do: [6]: docs/README/open-source.md [jp.computer]: https://jp.computer/ [reach out to us]: https://jp.computer/contact +[rfds via Web]: https://jp.computer/rfd/ +[rfds local]: docs/rfd/