docs
This commit is contained in:
37
Readme.md
37
Readme.md
@@ -1,22 +1,31 @@
|
||||
# Manual Slop
|
||||
|
||||
Vibe coding.. but more manual
|
||||
An AI coding assistant interface featuring multi-project management, rich discussion history, dynamic tool utilization, and a robust frontend.
|
||||
|
||||

|
||||
This tool is designed to work as an auxiliary assistant that natively interacts with your codebase via PowerShell and MCP-like file tools, supporting both Anthropic and Gemini APIs.
|
||||
|
||||
## Instructions
|
||||
Features:
|
||||
|
||||
1. Make a credentials.toml in the immediate directory of your clone:
|
||||
* Multi-provider support (Anthropic & Gemini).
|
||||
* Multi-project workspace management via TOML configuration.
|
||||
* Rich discussion history with branching and timestamps.
|
||||
* Real-time file context aggregation and summarization.
|
||||
* Integrated tool execution:
|
||||
* PowerShell scripting for file modifications.
|
||||
* MCP-like filesystem tools (read, list, search, summarize).
|
||||
* Web search and URL fetching.
|
||||
* Extensive UI features:
|
||||
* Word-wrap toggles.
|
||||
* Popup text viewers for large script/output inspection.
|
||||
* Color theming and UI scaling.
|
||||
|
||||
```toml
|
||||
[gemini]
|
||||
api_key = "****"
|
||||
[anthropic]
|
||||
api_key = "****"
|
||||
```
|
||||
## Documentation
|
||||
|
||||
2. Have fun. This is experiemntal slop.
|
||||
* [docs/Readme.md](docs/Readme.md) for the interface and usage guide
|
||||
* [docs/guide_tools.md](docs/guide_tools.md) for information on the AI tooling capabilities
|
||||
* [docs/guide_architecture.md](docs/guide_architecture.md) for an in-depth breakdown of the codebase architecture
|
||||
|
||||
```ps1
|
||||
uv run .\gui.py
|
||||
```
|
||||
## Running
|
||||
|
||||
Use `uv run gui.py` or `python gui.py` to launch the frontend.
|
||||
Requires a `credentials.toml` file in the root directory containing `gemini` and `anthropic` API keys.
|
||||
|
||||
Reference in New Issue
Block a user