dev-jas
commited on
Update README with detailed project information
Browse filesRemoved metadata and added a detailed description of CodeMind, including features, prerequisites, installation steps, usage instructions, troubleshooting, and contribution guidelines.
README.md
CHANGED
|
@@ -1,14 +1,3 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: CodeMind
|
| 3 |
-
emoji: 🔧
|
| 4 |
-
colorFrom: purple
|
| 5 |
-
colorTo: indigo
|
| 6 |
-
sdk: static
|
| 7 |
-
pinned: false
|
| 8 |
-
license: apache-2.0
|
| 9 |
-
short_description: AI-powered development assistant CLI Tool
|
| 10 |
-
---
|
| 11 |
-
|
| 12 |
**CodeMind** is a AI-powered development assistant that runs entirely on your local machine for intelligent document analysis and commit message generation. It leverages modern machine learning models for: helping you understand your codebase through semantic search and generates meaningful commit messages using locally hosted language models, ensuring complete privacy and no cloud dependencies.
|
| 13 |
|
| 14 |
- **Efficient Knowledge Retrieval**: Makes searching and querying documentation more powerful by using semantic embeddings rather than keyword search.
|
|
@@ -343,3 +332,4 @@ Contributions to CodeMind are welcome! Please feel free to submit pull requests,
|
|
| 343 |
This project is licensed under the terms of the LICENSE file included in the repository.
|
| 344 |
|
| 345 |
© 2025 CodeMind. All rights reserved.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
**CodeMind** is a AI-powered development assistant that runs entirely on your local machine for intelligent document analysis and commit message generation. It leverages modern machine learning models for: helping you understand your codebase through semantic search and generates meaningful commit messages using locally hosted language models, ensuring complete privacy and no cloud dependencies.
|
| 2 |
|
| 3 |
- **Efficient Knowledge Retrieval**: Makes searching and querying documentation more powerful by using semantic embeddings rather than keyword search.
|
|
|
|
| 332 |
This project is licensed under the terms of the LICENSE file included in the repository.
|
| 333 |
|
| 334 |
© 2025 CodeMind. All rights reserved.
|
| 335 |
+
|