Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
PriNova committed May 1, 2024
1 parent 8c43572 commit 4456ea5
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,29 @@ If you find **CodyArchitect** valuable and would like to support its ongoing dev

- **Comprehensive Reports**: The program generates multiple reports focusing on different aspects of the codebase, such as high-level architecture, module and class descriptions, and dependencies.

- **Detailed Module and Function Reports**: CodyArchitect dives into the details of each module and function, providing descriptions, dependencies, and how they fit into the overall architecture. This granular information helps developers quickly grasp the purpose and functionality of specific code components.
- **Detailed Module and Function Reports**: **CodyArchitect** dives into the details of each module and function, providing descriptions, dependencies, and how they fit into the overall architecture. This granular information helps developers quickly grasp the purpose and functionality of specific code components.

- **Semantic Code Understanding**: By employing advanced natural language processing techniques, CodyArchitect understands the semantics of code elements, enabling it to provide meaningful insights and summaries.
- **Semantic Code Understanding**: By employing advanced natural language processing techniques, **CodyArchitect** understands the semantics of code elements, enabling it to provide meaningful insights and summaries.

- **Vector Embeddings and Efficient Storage**: CodyArchitect generates vector embeddings of code elements and stores them in ChromaDB, along with relevant metadata. This enables quick retrieval and similarity-based searches for efficient navigation and understanding of the codebase.
- **Vector Embeddings and Efficient Storage**: **CodyArchitect** generates vector embeddings of code elements and stores them in ChromaDB, along with relevant metadata. This enables quick retrieval and similarity-based searches for efficient navigation and understanding of the codebase.

- **Markdown Output**: Reports are generated in easy-to-read Markdown format and stored on the file system for convenient access.

- **Command-Line Interface**: CodyArchitect offers a simple CLI where users can specify the directory of the codebase they want to analyze.
- **Command-Line Interface**: **CodyArchitect** offers a simple CLI where users can specify the directory of the codebase they want to analyze.

## How It Works

1. **User Input**: Provide the directory path of the codebase you want to analyze.
2. **Codebase Traversal**: CodyArchitect recursively traverses the codebase directory, collecting relevant documentation and source code files.
2. **Codebase Traversal**: **CodyArchitect** recursively traverses the codebase directory, collecting relevant documentation and source code files.
3. **Documentation Analysis**: The program extracts key information from documentation files using LLM, such as project description, architecture overview, and setup instructions.
4. **Code Analysis**: CodyArchitect identifies main modules, packages, classes, and functions within the codebase, extracting high-level and detailed information.
4. **Code Analysis**: **CodyArchitect** identifies main modules, packages, classes, and functions within the codebase, extracting high-level and detailed information.
5. **LLM Interaction**: The extracted information is processed by the LLM to generate concise summaries and descriptions of the codebase's components and their relationships.
6. **Embedding Generation**: Vector embeddings are generated for documentation and code elements, enabling efficient storage and retrieval in ChromaDB.
7. **Report Generation**: CodyArchitect generates comprehensive reports in Markdown format, including high-level overviews and detailed module/package reports.
7. **Report Generation**: **CodyArchitect** generates comprehensive reports in Markdown format, including high-level overviews and detailed module/package reports.

## Getting Started

To use CodyArchitect, follow these steps:
To use **CodyArchitect**, follow these steps:

1. Clone the repository: `git clone https://github.com/PriNova/CodyArchitect.git`
2. Install the required dependencies: `pip install -r requirements.txt`
Expand All @@ -47,14 +47,14 @@ To use CodyArchitect, follow these steps:

## Roadmap and Upcoming Features

We have an exciting roadmap planned for CodyArchitect, including:
We have an exciting roadmap planned for **CodyArchitect**, including:

- [ ] Graphical User Interface (GUI) implementation
- [ ] Automation processes for bug fixing, feature implementations and more

## Contribution Guidelines

At this early stage of development, I am not accepting pull requests. However, I welcome feedback, suggestions, and bug reports through the issue tracker. Your input is valuable in shaping the future of CodyArchitect.
At this early stage of development, I am not accepting pull requests. However, I welcome feedback, suggestions, and bug reports through the issue tracker. Your input is valuable in shaping the future of **CodyArchitect**.

## License

Expand Down

0 comments on commit 4456ea5

Please sign in to comment.