README-AI

Automatically generate beautiful README files powered by AI

Quick Links

• Overview
• Demo
• Features
• Getting Started
• Project Roadmap
• Contributing
• License

Overview

Objective Readme-ai is a dev tool that auto-generates detailed README.md files from the command-line using OpenAI's GPT models. Provide a repository URL or local directory path, and README-AI builds a well-structured README.md for your project. Motivation Streamlines documentation creation and maintenance, enhancing developer productivity. README-AI aims to improve the adoption of open-source software, enabling all skill levels and disciplines to understand, utilize, and contribute to projects more effectively.

[!WARNING]

This project is under development with an opinionated setup. It is vital to review the text generated by the OpenAI API to ensure it accurately represents your codebase.

Demo

Run readme-ai in your terminal via PyPI, Docker, and more.

readmeai-cli-demo

• CLI option --offline can be used to generate a README.md without an OpenAI API key.
• Useful for quickly getting a baseline document containg your project's metadata!

readmeai-cli-offline-demo

Features

    <span style="font-size: 2.0em;"> ❶ Badges</span>



<table>
    <tr>
        <td>
            <h4><i>Project Slogan and Badges</i></h4>



                ‣ A slogan to highlight your poject is generated by <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml#L33">prompting</a> OpenAI's GPT engine.






                ‣ Codebase dependencies and metadata are visualized using <a href="https://shields.io/">Shields.io</a> badges.



        </td>
    </tr>
    <tr>
        <td>
            <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/badges.png" alt="badges" />
        </td>
    </tr>
</table>
<table>



        ‣ Use the CLI option <code>--badges</code> to select the style of badges for your README!


        ‣ 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>

Command: none as its the default style for readme-ai

                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/badges-shieldsio-default.png" alt="badges-shieldsio-default" />



        </td>
    </tr>
    <tr>
        <td>
            <h4 style="text-align:left;">2. Shieldsio <em>for-the-badge</em> style</h4>

Command: --badges for-the-badge

                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/badges-shieldsio-flat.png" alt="badges-shieldsio-flat" />



        </td>
    </tr>
    <tr>
        <td>
            <h4 style="text-align:left;">3. Square <em>iOS style</em> badges</h4>

Command: --badges square

                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/badges-square.png" alt="badges-square" />



        </td>
    </tr>
</table>


















        <span style="font-size: 2.0em;"> ❷ Codebase Documentation</span>



    <table>
        <tr>
            <td colspan="2">
                <h4><i>Directory Tree and File Summaries</i></h4>
            </td>
        </tr>
        <tr>
            <td colspan="2">

‣ Your project's directory structure is visualized using a custom tree function.

‣ Each file in the codebase is summarized by OpenAI's GPT model.

            </td>
        </tr>
        <tr>
            <td align="center">
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/repository-tree.png" alt="repository-tree" />
            </td>
            <td align="center">
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/code-summaries.png" alt="code-summaries" />
            </td>
        </tr>
    </table>


















        <span style="font-size: 2.0em;"> ❸ Features Table</span>



    <table>
        <tr>
            <td>
                <h4><i>Prompted Text Generation</i></h4>



                    ‣ 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.



            </td>
        </tr>
        <tr>
            <td>
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/feature-table.png" alt="feature-table" />
            </td>
        </tr>
    </table>


















        <span style="font-size: 2.0em;"> ❹ Dynamic Usage Guides</span>





    <table>
        <tr>
            <td>
                <h4><i>Installation, Running, and Test</i></h4>



                    ‣ 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.



            </td>
        </tr>
        <tr>
            <td>
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/usage-instructions.png" alt="usage-instructions" />
            </td>
        </tr>
    </table>


















        <span style="font-size: 2.0em;"> ❺ Additional README Sections</span>





    <table>
        <tr>
            <td>
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/roadmap.png" alt="roadmap" />
            </td>
        </tr>



        <tr>
            <td>
                <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/license.png" alt="license" />
            </td>
        </tr>
    </table>


















    <span style="font-size: 2.0em;">❻ Templates (coming soon)</span>





<table>
    <tr>
        <td>

‣ Developing CLI option letting users select from a variety of README styles

‣ Templates for use-cases such as data, machine learning, web development, and more!

        </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>


















        <span style="font-size: 2.0em;"> ❼ Example README Files</span>





    <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/markdown/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/markdown/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/markdown/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/markdown/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>