diff --git a/README.md b/README.md index 3c4e7e3df08..736dc5463a5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ -## Documentation and Other Notes +## Why `aider-ce`? + +`aider-ce` (aka `cecli`) is a community-driven fork of the excellent [Aider](https://aider.chat/) AI pair programming tool. + +Our mission is to foster an open, collaborative ecosystem where new features, experiments, and improvements can be developed and shared rapidly. We believe in genuine FOSS principles and actively welcome contributors of all skill levels. + +If you are looking for bleeding-edge features or want to get your hands dirty with the internals of an AI coding agent, join us! + +You can see a selection of the improvements by comparing the help output: +```bash +aider --help > aider.help.txt +cecli --help > cecli.help.txt +diff aider.help.txt cecli.help.txt -uw --color +``` +Some of the bigger enhancements are: + * [Agent Mode](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/config/agent-mode.md) * [MCP Configuration](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/config/mcp.md) * [Session Management](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/sessions.md) * [Aider Original Documentation (still mostly applies)](https://aider.chat/) -* [Changelog](https://github.com/dwash96/aider-ce/blob/main/CHANGELOG.md) -* [Discord Community](https://discord.gg/McwdCRuqkJ) + +For a full list, check out the [Changelog](https://github.com/dwash96/aider-ce/blob/main/CHANGELOG.md) +Please drop by the [Discord Community](https://discord.gg/McwdCRuqkJ) +or [issue queue](https://github.com/dwash96/aider-ce/issues) to get involved. ## Installation Instructions This project can be installed using several methods: @@ -62,8 +79,8 @@ mcp-servers: | "context7":{ "transport":"http", "url":"https://mcp.context7.com/mcp" - } - } + } + } } ``` @@ -87,7 +104,7 @@ The current priorities are to improve core capabilities and user experience of t 2. **Repo Map Accuracy** - [Discussion](https://github.com/dwash96/aider-ce/issues/45) * [x] [Bias page ranking toward active/editable files in repo map parsing](https://github.com/Aider-AI/aider/issues/2405) - * [x] [Include import information in repo map for richer context](https://github.com/Aider-AI/aider/issues/2688) + * [x] [Include import information in repo map for richer context](https://github.com/Aider-AI/aider/issues/2688) * [x] [Handle non-unique symbols that break down in large codebases](https://github.com/Aider-AI/aider/issues/2341) 3. **Context Discovery** - [Discussion](https://github.com/dwash96/aider-ce/issues/46) @@ -98,7 +115,7 @@ The current priorities are to improve core capabilities and user experience of t 4. **Context Delivery** - [Discussion](https://github.com/dwash96/aider-ce/issues/47) * [ ] Use workflow for internal discovery to better target file snippets needed for specific tasks - * [ ] Add support for partial files and code snippets in model completion messages + * [ ] Add support for partial files and code snippets in model completion messages 5. **TUI Experience** - [Discussion](https://github.com/dwash96/aider-ce/issues/48) * [ ] Add a full TUI (probably using textual) to have a visual interface competitive with the other coding agent terminal programs @@ -145,4 +162,4 @@ The current priorities are to improve core capabilities and user experience of t @youknow04 @pcamp @miradnanali -@o-nix \ No newline at end of file +@o-nix