[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/aidermacs c42ff4fbd1 414/466: Format README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/aidermacs c42ff4fbd1 414/466: Format README |
Date: |
Sat, 15 Mar 2025 19:19:23 -0400 (EDT) |
branch: elpa/aidermacs
commit c42ff4fbd1eb39a9432e112cc90d278bb602f510
Author: Mingde (Matthew) Zeng <matthewzmd@posteo.net>
Commit: Mingde (Matthew) Zeng <matthewzmd@posteo.net>
Format README
---
README.md | 51 ++++++---------------------------------------------
1 file changed, 6 insertions(+), 45 deletions(-)
diff --git a/README.md b/README.md
index 25e66d0652..0f8ee640f1 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,11 @@ Missing [Cursor](https://cursor.sh) but prefer living in
Emacs? Aidermacs brings
## Why Aidermacs?
-<p align="center">
- <img style='height: auto; width: 80%; object-fit: contain'
src="./introscreen.png">
-</p>
+<img style='height: auto; width: 80%; object-fit: contain'
src="./introscreen.png">
-### Video Demo!
+### Video Demo
-[<img src="https://img.youtube.com/vi/TPpyxaGZg1A/0.jpg"
width=400>](https://www.youtube.com/watch?v=TPpyxaGZg1A)
+[<img src="https://img.youtube.com/vi/TPpyxaGZg1A/0.jpg"
width=600>](https://www.youtube.com/watch?v=TPpyxaGZg1A)
### Community-Driven Development
@@ -387,50 +385,13 @@ With `Aidermacs`, you get:
... and more to come 🚀
-## Troubleshooting
-
-### Aider not found
-- Ensure Aider is installed: `pip install aider-chat`
-- Check `aidermacs-program` points to correct path
-
-### No response from AI
-- Verify API keys are set correctly
-- Check model selection matches your API access
-- Try simpler prompts first
-
-### Ediff not working
-- Ensure `ediff` is installed
-- Check file permissions
-- Try restarting Emacs
-
-## Example Workflows
-
-### Implementing a Feature
-1. Add relevant files with `f` or `F`
-2. Switch to Architect mode with `3`
-3. Describe the feature: "/architect Implement user login system"
-4. Review changes with Ediff
-5. Accept/reject changes
-
-### Debugging Code
-1. Add file with error
-2. Place cursor on error
-3. Run `!` (Debug Exception)
-4. Follow AI's debugging steps
-
-### Writing Tests
-1. Add file to test
-2. Run `t` (Write Test)
-3. Review generated tests
-4. Run tests to verify
-
## FAQ
-### How is this different from Copilot?
-Aidermacs uses Aider which is more focused on code modification and
architecture rather than just completion.
+### Aider?
+Please check [Aider's FAQ](https://aider.chat/docs/faq.html) for Aider related
questions.
### Can I use my own AI models?
-Yes! Aidermacs supports any OpenAI-compatible API endpoint.
+Yes! Aidermacs supports any OpenAI-compatible API endpoint. Check Aider
documentation on [Ollama](https://aider.chat/docs/llms/ollama.html) and
[LiteLLM](https://aider.chat/docs/llms/other.html).
### Is my code sent to the AI provider?
Yes, the code you add to the session is sent to the AI provider. Be mindful of
sensitive code.
- [nongnu] elpa/aidermacs 95620db88f 388/466: Make correct defvar-locals, (continued)
- [nongnu] elpa/aidermacs 95620db88f 388/466: Make correct defvar-locals, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 07f3d319b1 392/466: Preliminary implementation of ediff capture diffs, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 9a41203b04 395/466: Update README, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 9db897d312 399/466: Add aidermacs--cleanup-temp-files-on-interrupt, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 25b10e6e59 398/466: Improve aidermacs--last-command, aidermacs--parse-output-for-files, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 3f49d59402 404/466: Bump to 1.0.0, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 69cdacaaa0 409/466: Requested changes, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs b641c16de5 407/466: Fix linting, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 3f84f16668 405/466: Fix aidermacs--prepare-for-code-edit, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs d76bc38c0b 411/466: Improve aidermacs--detect-edited-files, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs c42ff4fbd1 414/466: Format README,
ELPA Syncer <=
- [nongnu] elpa/aidermacs 5b812f26e5 419/466: Check udiff cases, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 0c236ac3d6 421/466: Fix aidermacs-prompt-regexp and fix aidermacs--parse-ls-output, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs ddd8000e17 424/466: Add Melpa!, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs b4a771c777 425/466: Fix #52, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 9a8575e7de 430/466: Use minor mode for relevant functions, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 389d69fddb 428/466: refactor: add aidermacs-comint-mode minor mode., ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 66d04629bc 431/466: Fix linting, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 1971d48717 432/466: Fix linting, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 9644836022 434/466: Do not suggest auto commit, ELPA Syncer, 2025/03/15
- [nongnu] elpa/aidermacs 47327b96d2 435/466: fix(aidermacs-models): ensure correct parsing by moving to end of headers, ELPA Syncer, 2025/03/15