-
Notifications
You must be signed in to change notification settings - Fork 188
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
36 changed files
with
391 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,274 @@ | ||
| ## Key Features | ||
|
|
||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❶ Badges</span> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <h4><i>Project Slogan and Badges</i></h4> | ||
| <p> | ||
| ‣ A slogan to highlight your poject is generated by <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml#L70">prompting</a> OpenAI's GPT engine. | ||
| </p> | ||
| <p> | ||
| ‣ Codebase dependencies and metadata are visualized using <a href="https://shields.io/">Shields.io</a> badges. | ||
| </p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/badges.png" alt="badges" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <table> | ||
| <p> | ||
| ‣ Use the CLI option <code>--badges</code> to select the style of badges for your README! <br> | ||
| ‣ 6 options currently supported: <i>flat (default), flat-square, plastic, for-the-badge, social, square</i>. Find a few examples below. | ||
| <tr> | ||
| <td> | ||
| <h4 style="text-align:left;">1. Shieldsio <em>flat</em> badge style</h4> | ||
| <p style="text-align:left;">Command: none as its the default style for <em>readme-ai</em></p> | ||
| <div style="text-align:center;"> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/badges-shieldsio-default.png" alt="badges-shieldsio-default" /> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <h4 style="text-align:left;">2. Shieldsio <em>for-the-badge</em> style</h4> | ||
| <p style="text-align:left;">Command: <code>--badges for-the-badge</code></p> | ||
| <div style="text-align:center;"> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/badges-shieldsio-flat.png" alt="badges-shieldsio-flat" /> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <h4 style="text-align:left;">3. Square <em>iOS style</em> badges</h4> | ||
| <p style="text-align:left;">Command: <code>--badges square</code></p> | ||
| <div style="text-align:center;"> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/badges-square.png" alt="badges-square" /> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❷ Codebase Documentation</span> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td colspan="2"> | ||
| <h4><i>Directory Tree and File Summaries</i></h4> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="2"> | ||
| <p>‣ Your project's directory structure is visualized using a custom tree function.</p> | ||
| <p>‣ Each file in the codebase is summarized by OpenAI's <i>GPT</i> model.</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/repository-tree.png" alt="repository-tree" /> | ||
| </td> | ||
| <td align="center"> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/code-summaries.png" alt="code-summaries" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❸ Features Table</span> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <h4><i>Prompted Text Generation</i></h4> | ||
| <p> | ||
| ‣ An overview paragraph and features table are generated using <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml#L28">detailed prompts</a>, embedded with project metadata. | ||
| </p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/feature-table.png" alt="feature-table" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❹ Dynamic Usage Guides</span><br> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <h4><i>Installation, Running, and Test</i></h4> | ||
| <p> | ||
| ‣ Generates instructions for installing, running, and testing your project. Instructions are created by identifying the codebase's top language and referring to our <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/language_setup.toml">language_setup.toml</a> configuration file. | ||
| </p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/usage-instructions.png" alt="usage-instructions" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❺ Additional README Sections</span><br> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/roadmap.png" alt="roadmap" /> | ||
| </td> | ||
| </tr> | ||
| <br> | ||
| <tr> | ||
| <td> | ||
| <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/license.png" alt="license" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;">❻ Templates (coming soon)</span><br> | ||
| </summary> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <p>‣ Developing CLI option letting users select from a variety of README styles</p> | ||
| <p>‣ Templates for use-cases such as data, machine learning, web development, and more!</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <h3>AI and ML README Template Concept</h3> | ||
| <ul> | ||
| <li><strong><a href="#overview">Overview</a></strong>: Summary of the projects' objectives, scope, and expected outcomes.</li> | ||
| <li><strong><a href="#project-structure">Project Structure</a></strong>: Overview of the organization of the projects and their main components.</li> | ||
| <li><strong><a href="#data-collection-and-preprocessing">Data Preprocessing</a></strong>: Data sources, collection methods, and types of data</li> | ||
| <li><strong><a href="#feature-engineering">Feature Engineering</a></strong>: Importance of feature engineering and its impact on model performance.</li> | ||
| <li><strong><a href="#model-architecture-and-development">Model Architecture and Development</a></strong>: Model selection, dev strategies, and implemented algorithms.</li> | ||
| <li><strong><a href="#training-and-validation">Training and Validation</a></strong>: Info on model training procedures, hyperparameter tuning, and validation strategies.</li> | ||
| <li><strong><a href="#testing-and-evaluation">Testing and Evaluation</a></strong>: Model testing results, performance analysis, and comparison with benchmarks.</li> | ||
| <li><strong><a href="#deployment-and-integration">Deployment and Integration</a></strong>: Integration with other systems, APIs, and user interfaces</li> | ||
| <li><strong><a href="#usage-and-maintenance">Usage and Maintenance</a></strong>: User guide on how to use the deployed models and interfaces.</li> | ||
| <li><strong><a href="#results-and-discussion">Results and Discussion</a></strong>: Implications, limitations, and future work.</li> | ||
| <li><strong><a href="#ethical-considerations">Ethical Considerations</a></strong>: Ethical aspects, data privacy, and fairness in model predictions.</li> | ||
| <li><strong><a href="#contributing">Contributing</a></strong>: Procedures for submitting contributions, reporting issues, and proposing enhancements.</li> | ||
| <li><strong><a href="#acknowledgements">Acknowledgements</a></strong>: References to resources, libraries, and frameworks used.</li> | ||
| <li><strong><a href="#license">License</a></strong>: Explanation of usage rights, restrictions, and attribution requirements.</li> | ||
| </ul> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> | ||
| <div> | ||
| <details> | ||
| <summary style="display: flex; align-items: center;"> | ||
| <span style="font-size: 2.0em;"> ❼ Example README Files</span><br> | ||
| </summary> | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th></th> | ||
| <th>Output File</th> | ||
| <th>Repository</th> | ||
| <th>Languages</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>1️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-python.md">readme-python.md</a></td> | ||
| <td><a href="https://github.com/eli64s/readme-ai">readme-ai</a></td> | ||
| <td>Python</td> | ||
| </tr> | ||
| <tr> | ||
| <td>2️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-typescript.md">readme-typescript.md</a></td> | ||
| <td><a href="https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript">chatgpt-app-react-typescript</a></td> | ||
| <td>TypeScript, React</td> | ||
| </tr> | ||
| <tr> | ||
| <td>3️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-javascript.md">readme-javascript.md</a></td> | ||
| <td><a href="https://github.com/idosal/assistant-chat-gpt-javascript">assistant-chat-gpt-javascript</a></td> | ||
| <td>JavaScript, React</td> | ||
| </tr> | ||
| <tr> | ||
| <td>4️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md">readme-kotlin.md</a></td> | ||
| <td><a href="https://github.com/rumaan/file.io-Android-Client">file.io-android-client</a></td> | ||
| <td>Kotlin, Java, Android</td> | ||
| </tr> | ||
| <tr> | ||
| <td>5️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md">readme-rust-c.md</a></td> | ||
| <td><a href="https://github.com/DownWithUp/CallMon">rust-c-app</a></td> | ||
| <td>C, Rust</td> | ||
| </tr> | ||
| <tr> | ||
| <td>6️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-go.md">readme-go.md</a></td> | ||
| <td><a href="https://github.com/olliefr/docker-gs-ping">go-docker-app</a></td> | ||
| <td>Go</td> | ||
| </tr> | ||
| <tr> | ||
| <td>7️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md">readme-java.md</a></td> | ||
| <td><a href="https://github.com/avjinder/Minimal-Todo">java-minimal-todo</a></td> | ||
| <td>Java</td> | ||
| </tr> | ||
| <tr> | ||
| <td>8️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md">readme-fastapi-redis.md</a></td> | ||
| <td><a href="https://github.com/FerrariDG/async-ml-inference">async-ml-inference</a></td> | ||
| <td>Python, FastAPI, Redis</td> | ||
| </tr> | ||
| <tr> | ||
| <td>9️⃣</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md">readme-mlops.md</a></td> | ||
| <td><a href="https://github.com/GokuMohandas/mlops-course">mlops-course</a></td> | ||
| <td>Python, Jupyter</td> | ||
| </tr> | ||
| <tr> | ||
| <td>🔟</td> | ||
| <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-pyflink.md">readme-pyflink.md</a></td> | ||
| <td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td> | ||
| <td>PyFlink</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </details> | ||
| </div> | ||
| <br> |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,30 +4,30 @@ build-backend = "poetry.core.masonry.api" | |
|
|
||
| [tool.poetry] | ||
| name = "readmeai" | ||
| version = "0.4.031" | ||
| description = "Automated README.md file generator tool, powered by AI 🧚" | ||
| version = "0.4.032" | ||
| description = "Generate beautiful README.md files from the terminal, powered by AI." | ||
| authors = ["Eli <[email protected]>"] | ||
| license = "MIT" | ||
| readme = "README.md" | ||
| homepage = "https://github.com/eli64s/readme-ai" | ||
| documentation = "https://github.com/eli64s/readme-ai/blob/main/README.md" | ||
| keywords = [ | ||
| "markdown", | ||
| keywords = [ | ||
| "github", | ||
| "productivity", | ||
| "readme", | ||
| "documentation", | ||
| "ai", | ||
| "devtools", | ||
| "readme-badges", | ||
| "openai", | ||
| "gpt", | ||
| "readme-template", | ||
| "workflow-automation", | ||
| "autodoc", | ||
| "readme-md", | ||
| "readme-generator", | ||
| "openai-api", | ||
| "gpt-4", | ||
| "llm", | ||
| "chatgpt" | ||
| "chatgpt", | ||
| "auto-readme" | ||
| ] | ||
| include = ["readmeai", "readmeai.*"] | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters