From 0f241d273ede45101ae920e653abdb6085fc28d5 Mon Sep 17 00:00:00 2001 From: eli64s Date: Sun, 27 Oct 2024 03:58:23 +0000 Subject: [PATCH] deploy: 5ff342fb38cffec936cf959365d7e6911159dd8d --- blog/index.html | 2 +- cli/index.html | 2 +- configuration/badges/index.html | 2 +- configuration/emojis/index.html | 2 +- configuration/header/index.html | 2 +- configuration/project_logo/index.html | 2 +- configuration/table_of_contents/index.html | 2 +- contributing/index.html | 2 +- examples/gallery/index.html | 2 +- examples/use_cases/index.html | 2 +- faq/index.html | 2 +- guides/best_practices/index.html | 2 +- guides/custom_templates/index.html | 2 +- guides/markdown/index.html | 2 +- index.html | 2 +- llms/anthropic/index.html | 2 +- llms/google_gemini/index.html | 2 +- llms/index.html | 2 +- llms/offline_mode/index.html | 2 +- llms/ollama/index.html | 2 +- llms/openai/index.html | 2 +- philosophy/index.html | 2 +- sitemap.xml | 62 ++++++++++----------- sitemap.xml.gz | Bin 450 -> 450 bytes troubleshooting/index.html | 2 +- usage/cli/index.html | 2 +- usage/docker/index.html | 2 +- usage/environment/index.html | 2 +- usage/installation/index.html | 2 +- usage/prerequisites/index.html | 2 +- usage/python/index.html | 2 +- usage/streamlit/index.html | 2 +- why/index.html | 2 +- 33 files changed, 62 insertions(+), 62 deletions(-) diff --git a/blog/index.html b/blog/index.html index 3e1d7fa5..c62d0ace 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

Blog

✨ coming soon ...

\ No newline at end of file +
Skip to content

Blog

✨ coming soon ...

\ No newline at end of file diff --git a/cli/index.html b/cli/index.html index 4ef96270..e9bc5711 100644 --- a/cli/index.html +++ b/cli/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

CLI Reference

README-AI offers a wide range of configuration options to customize your README generation. This page provides a comprehensive list of all available options with detailed explanations.

Options

Option Description Default Impact
--align Text alignment in header center Affects the visual layout of the README header
--api LLM API service offline Determines which AI service is used for content generation
--badge-color Badge color (name or hex) 0080ff Customizes the color of status badges in the README
--badge-style Badge icon style type flat Changes the visual style of status badges
--base-url Base URL for the repository v1/chat/completions Used for API requests to the chosen LLM service
--context-window Max context window of LLM API 3999 Limits the amount of context provided to the LLM
--emojis Add emojis to README sections False Adds visual flair to section headers
--header-style Header template style classic Changes the overall look of the README header
--image Project logo image blue Sets the main image displayed in the README
--model Specific LLM model to use gpt-3.5-turbo Chooses the AI model for content generation
--output Output filename readme-ai.md Specifies the name of the generated README file
--rate-limit Max API requests per minute 5 Prevents exceeding API rate limits
--repository Repository URL or local path None Specifies the project to analyze
--temperature Creativity level for generation 0.9 Controls the randomness of the AI's output
--toc-style Table of contents style bullet Changes the format of the table of contents
--top-p Top-p sampling probability 0.9 Fine-tunes the AI's output diversity
--tree-depth Max depth of directory tree 2 Controls the detail level of the project structure

Some options have a significant impact on the generated README's appearance and content. Experiment with different settings to find the best configuration for your project!

\ No newline at end of file +
Skip to content

CLI Reference

README-AI offers a wide range of configuration options to customize your README generation. This page provides a comprehensive list of all available options with detailed explanations.

Options

Option Description Default Impact
--align Text alignment in header center Affects the visual layout of the README header
--api LLM API service offline Determines which AI service is used for content generation
--badge-color Badge color (name or hex) 0080ff Customizes the color of status badges in the README
--badge-style Badge icon style type flat Changes the visual style of status badges
--base-url Base URL for the repository v1/chat/completions Used for API requests to the chosen LLM service
--context-window Max context window of LLM API 3999 Limits the amount of context provided to the LLM
--emojis Add emojis to README sections False Adds visual flair to section headers
--header-style Header template style classic Changes the overall look of the README header
--image Project logo image blue Sets the main image displayed in the README
--model Specific LLM model to use gpt-3.5-turbo Chooses the AI model for content generation
--output Output filename readme-ai.md Specifies the name of the generated README file
--rate-limit Max API requests per minute 5 Prevents exceeding API rate limits
--repository Repository URL or local path None Specifies the project to analyze
--temperature Creativity level for generation 0.9 Controls the randomness of the AI's output
--toc-style Table of contents style bullet Changes the format of the table of contents
--top-p Top-p sampling probability 0.9 Fine-tunes the AI's output diversity
--tree-depth Max depth of directory tree 2 Controls the detail level of the project structure

Some options have a significant impact on the generated README's appearance and content. Experiment with different settings to find the best configuration for your project!

\ No newline at end of file diff --git a/configuration/badges/index.html b/configuration/badges/index.html index a20f3bc0..57c62c33 100644 --- a/configuration/badges/index.html +++ b/configuration/badges/index.html @@ -8,4 +8,4 @@
Skip to content

Badges

A badge is a simple embeddable icon that displays various metrics such as the number of stars or forks for a repository, languages used in the project, CI/CD build status, test coverage, the license of the project, and more. Badges are a great way to provide quick information about your project to users and visitors.

README-AI offers various badge styles to enhance your project's README. This guide explains how to use and customize these badges.

Badge Styles

Use the --badge-style option to select from the following styles:

Default Badge Default Badge Default Badge Default Badge

Flat Badge

Flat-Square Badge

For-the-Badge Badge

Plastic Badge

Skills Badge

Skills-Light Badge

Social Badge

How It Works

README-AI automatically detects your project's dependencies and technologies during the repository ingestion process. It then uses these dependencies and technologies to generate a comprehensive list of relevant badges for your project.

When you provide the --badge-style option to the readmeai command, two sets of badges are generated:

  1. Default Metadata Badges: The default set is always included in the generated README file. The default badges include the project license, last commit, top language, and total languages.
  2. Project Dependency Badges: When the --badge-style argument is provided to the CLI, a second badge set is generated, representing the extracted dependencies and metadata from your codebase.

The badge sets are formatted in the README header and provide the reader with a quick overview of the project's key metrics and technologies.

Usage

Let's generate a README with custom badge colors and styles using the --badge-color and --badge-style options:

readmeai --badge-color orange \
          --badge-style flat-square \
          --repository https://github.com/eli64s/readme-ai
-

The command above generates a README with the following badge configuration:

Example

License Last Commit Top Language Language Count

Built with the tools and technologies:

pre-commit Ruff GNU Bash Pytest Docker Python GitHub Actions Poetry AIOHTTP Material for MkDocs OpenAI Google Gemini Pydantic

The --badge-color option only modifies the default badge set, while the --badge-style option is applied to both the default and project dependency badges

Tips for Using Badges

  • Choose a badge style that complements your project's overall design.
  • Use badges to highlight relevant information about your project, such as license, build status, and test coverage.
  • Don't overuse badges – too many can clutter your README and make it hard to read.
  • Ensure that all badge links are correct and up-to-date.
  • Consider using custom badges for project-specific information or metrics.

References

Thank you to the following resources for providing open-source badges and icons:

\ No newline at end of file +

The command above generates a README with the following badge configuration:

Example

License Last Commit Top Language Language Count

Built with the tools and technologies:

pre-commit Ruff GNU Bash Pytest Docker Python GitHub Actions Poetry AIOHTTP Material for MkDocs OpenAI Google Gemini Pydantic

The --badge-color option only modifies the default badge set, while the --badge-style option is applied to both the default and project dependency badges

Tips for Using Badges

References

Thank you to the following resources for providing open-source badges and icons:

\ No newline at end of file diff --git a/configuration/emojis/index.html b/configuration/emojis/index.html index ec18c4a4..9a9192a9 100644 --- a/configuration/emojis/index.html +++ b/configuration/emojis/index.html @@ -6,4 +6,4 @@ "url": "https://docs.readme-ai.com/" }
Skip to content

Emojis

(🚧 work in progress 🚧)

Emojis are a fun way to add some personality to your README.md file. README-AI allows you to automatically add emojis to all headers in the generated README file by providing the --emojis option to the readmeai command.

How It Works

When you provide the --emojis option to the readmeai command, README-AI automatically adds emojis to all headers in the generated README file.

(🚧 work in progress 🚧)

(🚧 work in progress 🚧)

Usage

To enable emojis in the generated README file, use the --emojis option when running the readmeai command:

readmeai --repository <your-repo-url> --emojis
-
\ No newline at end of file +
\ No newline at end of file diff --git a/configuration/header/index.html b/configuration/header/index.html index 3178f7eb..3baf7c49 100644 --- a/configuration/header/index.html +++ b/configuration/header/index.html @@ -107,4 +107,4 @@ By customizing and extending the header templates, you can fully control the look and feel of your README header to match your project’s branding and style. --- --->
\ No newline at end of file +-->
\ No newline at end of file diff --git a/configuration/project_logo/index.html b/configuration/project_logo/index.html index 81a164c6..1a225988 100644 --- a/configuration/project_logo/index.html +++ b/configuration/project_logo/index.html @@ -9,4 +9,4 @@

Providing a Custom Image

You can provide readme-ai with a custom image by using the --image custom option:

readmeai --image custom --repository https://github.com/username/project

You will be prompted to provide a path to your image on your local machine or via URL:

Provide an image file path or URL:

LLM Image Generation

To generate a logo using a text-to-image model from a LLM API (i.e. OpenAI), use the --image llm option:

readmeai --image llm --api openai --repository https://github.com/username/project
-

This will generate a unique logo that you can display in your project's documentation. The prompt used for text-to-image generation can be found here.

Example

The following examples show generated logos by readme-ai for various open-source projects:

Project Logo

README-AI

Project Logo

README-AI

Project Logo

README-AI-STREAMLIT

Project Logo

GITHUB-README-QUOTES

⚠ The quality and relevance of LLM-generated logos can vary. It's a good idea to review and potentially edit the generated logo to ensure it meets your project's needs.

Tips for Using Project Logos

\ No newline at end of file +

This will generate a unique logo that you can display in your project's documentation. The prompt used for text-to-image generation can be found here.

Example

The following examples show generated logos by readme-ai for various open-source projects:

Project Logo

README-AI

Project Logo

README-AI

Project Logo

README-AI-STREAMLIT

Project Logo

GITHUB-README-QUOTES

⚠ The quality and relevance of LLM-generated logos can vary. It's a good idea to review and potentially edit the generated logo to ensure it meets your project's needs.

Tips for Using Project Logos

\ No newline at end of file diff --git a/configuration/table_of_contents/index.html b/configuration/table_of_contents/index.html index a099eb70..df1d0f9a 100644 --- a/configuration/table_of_contents/index.html +++ b/configuration/table_of_contents/index.html @@ -11,4 +11,4 @@ --header-style modern \ --badge-style flat \ --repository https://github.com/username/project -
\ No newline at end of file +
\ No newline at end of file diff --git a/contributing/index.html b/contributing/index.html index 5df83eae..06fe9428 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

Contributing Guidelines

Thanks for your interest in contributing to readme-ai. Please review these guidelines to ensure a smooth process.

Make Valuable Contributions

Strive to make useful, creative, and high quality contributions. This isn't meant to be a high bar, but more of a guiding principle and philosophy. Here's what we mean by these terms:

Useful: Solve common problems, use cases, bugs, or new features.

Creative: Innovative and helping us all grow and learn new things.

High Quality: Well-written, structured, and explained.

Ways to Contribute

To improve and grow the project, we need your help! Here are some ways to get involved:

Activity Ideas
👋 Discussions Start a discussion by asking a question or making a suggestion.
🐛 Open an Issue Find unhandled exceptions and bugs in the codebase.
📄 Documentation Write documentation for the project.
🧪 Testing Write unit tests to increase code coverage.
🧩 Feature Requests Brainstorm new ideas such as a CLI option to select any language.
🛠️ Code Contributions Contribute to the codebase and submit a pull request.
🔢 Code Readability Find ways to make code more readable and easier to understand.
🤔 Other Anything else you can think of!

These are just a few examples, and we welcome any other ideas you may have!

Submitting Changes

  1. Fork the repository and clone it locally.
  2. Create a new branch with a descriptive name i.e feature/new-feature-name or bugfix-issue-123.
  3. Make focused changes with clear commits.
  4. Open a pull request document the changes you've made and why they're necessary.
  5. Respond to code reviews from maintainers.

Code Quality Expectations

  • Clear, well-documented code
  • Include tests for new code
  • Follow project style standards
  • Rebase onto latest main branch

Attribution

Contributors to our project will be acknowledged in the project's README.md file.

License

By contributing to our project, you agree to license your contributions under the project's open source license. The project's license can be found in the LICENSE

Thank you for your interest in contributing to readme-ai! We appreciate your help and look forward to working with you.

\ No newline at end of file +
Skip to content

Contributing Guidelines

Thanks for your interest in contributing to readme-ai. Please review these guidelines to ensure a smooth process.

Make Valuable Contributions

Strive to make useful, creative, and high quality contributions. This isn't meant to be a high bar, but more of a guiding principle and philosophy. Here's what we mean by these terms:

Useful: Solve common problems, use cases, bugs, or new features.

Creative: Innovative and helping us all grow and learn new things.

High Quality: Well-written, structured, and explained.

Ways to Contribute

To improve and grow the project, we need your help! Here are some ways to get involved:

Activity Ideas
👋 Discussions Start a discussion by asking a question or making a suggestion.
🐛 Open an Issue Find unhandled exceptions and bugs in the codebase.
📄 Documentation Write documentation for the project.
🧪 Testing Write unit tests to increase code coverage.
🧩 Feature Requests Brainstorm new ideas such as a CLI option to select any language.
🛠️ Code Contributions Contribute to the codebase and submit a pull request.
🔢 Code Readability Find ways to make code more readable and easier to understand.
🤔 Other Anything else you can think of!

These are just a few examples, and we welcome any other ideas you may have!

Submitting Changes

  1. Fork the repository and clone it locally.
  2. Create a new branch with a descriptive name i.e feature/new-feature-name or bugfix-issue-123.
  3. Make focused changes with clear commits.
  4. Open a pull request document the changes you've made and why they're necessary.
  5. Respond to code reviews from maintainers.

Code Quality Expectations

  • Clear, well-documented code
  • Include tests for new code
  • Follow project style standards
  • Rebase onto latest main branch

Attribution

Contributors to our project will be acknowledged in the project's README.md file.

License

By contributing to our project, you agree to license your contributions under the project's open source license. The project's license can be found in the LICENSE

Thank you for your interest in contributing to readme-ai! We appreciate your help and look forward to working with you.

\ No newline at end of file diff --git a/examples/gallery/index.html b/examples/gallery/index.html index bfb394f4..01e21cd8 100644 --- a/examples/gallery/index.html +++ b/examples/gallery/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

Gallery

Explore various README examples from different programming languages and technologies. Each example showcases a README file from a different repository and project type. | Technology | Example Output | Repository | Description | |------------|---------------|------------|-------------| | Readme-ai | readme-ai.md | readme-ai | Readme-ai project | | Apache Flink | readme-pyflink.md | pyflink-poc | Pyflink project | | Streamlit | readme-streamlit.md | readme-ai-streamlit | Streamlit web app | | Vercel & NPM | readme-vercel.md | github-readme-quotes | Vercel deployment | | Go & Docker | readme-docker-go.md | docker-gs-ping | Dockerized Go app | | FastAPI & Redis | readme-fastapi-redis.md | async-ml-inference | Async ML inference service | | Java | readme-java.md | Minimal-Todo | Minimalist todo Java app | | PostgreSQL & DuckDB | readme-postgres.md | Buenavista | Postgres proxy server | | Kotlin | readme-kotlin.md | android-client | Android client app | | Offline Mode | offline-mode.md | litellm | LLM API service |

Find additional README examples in the examples directory.

Share Your README

To improve readme-ai and grow the community, we'd love to see the READMEs you created. If you have a README file that you'd like to share, please share it with us here. Cheers!

\ No newline at end of file +
Skip to content

Gallery

Explore various README examples from different programming languages and technologies. Each example showcases a README file from a different repository and project type. | Technology | Example Output | Repository | Description | |------------|---------------|------------|-------------| | Readme-ai | readme-ai.md | readme-ai | Readme-ai project | | Apache Flink | readme-pyflink.md | pyflink-poc | Pyflink project | | Streamlit | readme-streamlit.md | readme-ai-streamlit | Streamlit web app | | Vercel & NPM | readme-vercel.md | github-readme-quotes | Vercel deployment | | Go & Docker | readme-docker-go.md | docker-gs-ping | Dockerized Go app | | FastAPI & Redis | readme-fastapi-redis.md | async-ml-inference | Async ML inference service | | Java | readme-java.md | Minimal-Todo | Minimalist todo Java app | | PostgreSQL & DuckDB | readme-postgres.md | Buenavista | Postgres proxy server | | Kotlin | readme-kotlin.md | android-client | Android client app | | Offline Mode | offline-mode.md | litellm | LLM API service |

Find additional README examples in the examples directory.

Share Your README

To improve readme-ai and grow the community, we'd love to see the READMEs you created. If you have a README file that you'd like to share, please share it with us here. Cheers!

\ No newline at end of file diff --git a/examples/use_cases/index.html b/examples/use_cases/index.html index d5a1607a..b9d9609f 100644 --- a/examples/use_cases/index.html +++ b/examples/use_cases/index.html @@ -97,4 +97,4 @@ readmeai --repository /path/to/project \ --api openai \ --toc-style fold -``` -->
\ No newline at end of file +``` -->
\ No newline at end of file diff --git a/faq/index.html b/faq/index.html index e3184df2..3829b019 100644 --- a/faq/index.html +++ b/faq/index.html @@ -21,4 +21,4 @@ > * **Review Sensitive Information**: Ensure all content in your repository is free of sensitive information before running the tool. This project does not remove sensitive data from your codebase, nor from the output README file. > > * **API Usage Costs**: The OpenAI API is not free and costs can accumulate quickly! You will be charged for each request made by readme-ai. Be sure to monitor API usage costs using the [OpenAI API Usage Dashboard](https://platform.openai.com/account/usage). --->
\ No newline at end of file +-->
\ No newline at end of file diff --git a/guides/best_practices/index.html b/guides/best_practices/index.html index f7d0e97a..7f0594d2 100644 --- a/guides/best_practices/index.html +++ b/guides/best_practices/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -

Best Practices

\ No newline at end of file +

Best Practices

\ No newline at end of file diff --git a/guides/custom_templates/index.html b/guides/custom_templates/index.html index ff736c1a..f29665c8 100644 --- a/guides/custom_templates/index.html +++ b/guides/custom_templates/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -

Custom Templates

\ No newline at end of file +

Custom Templates

\ No newline at end of file diff --git a/guides/markdown/index.html b/guides/markdown/index.html index 889adae3..f0434a65 100644 --- a/guides/markdown/index.html +++ b/guides/markdown/index.html @@ -102,4 +102,4 @@ mermaid.initialize(config);

Return To Top

Return

Return

Return

HTML Spacing Entities

Name HTML Entity Description
En space &ensp; Half the width of an em space
Em space &emsp; Width of an em space (equal to the font size)
Three-per-em space &emsp13; One-third of an em space
Figure space &numsp; Width of a numeral (digit)
Punctuation space &puncsp; Width of a period or comma
Thin space &thinsp; Thinner than a regular space
Hair space &hairsp; Thinner than a thin space
Narrow no-break space &#8239; Non-breaking thin space

Note: The &emsp13; and &puncsp; entities may not be supported in all browsers. For the narrow no-break space, there isn't a named HTML entity, so the numeric character reference &#8239; is used.

inline link reference link

reference link 2

Contact

Simple Contact

If you have any questions or comments, feel free to reach out to me! - Email: your-email@example.com - Twitter: @YourHandle

Modern Contact with Social Icons

For readme-ai issues and feature requests please visit our issues page, or start a discussion!

eli64s GitHub space Ultralytics LinkedIn space Ultralytics Twitter space

Contributing Guidelines

Contributing Graph

References

Footnotes

Here's a sample sentence with a footnote.[^1]

[^1]: And here's the definition of the footnote.

\ No newline at end of file +-->

Modern Contact with Social Icons

For readme-ai issues and feature requests please visit our issues page, or start a discussion!

eli64s GitHub space Ultralytics LinkedIn space Ultralytics Twitter space

Contributing Guidelines

Contributing Graph

References

Footnotes

Here's a sample sentence with a footnote.[^1]

[^1]: And here's the definition of the footnote.

\ No newline at end of file diff --git a/index.html b/index.html index 7ebc5120..213bb085 100644 --- a/index.html +++ b/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

readme-ai

Your AI-Powered Documentation Assistant

Modern documentation generator combining advanced AI with robust data processing

Getting Started → View on GitHub →
GitHub Actions PyPI Version Downloads License
🚀

Automated Documentation

Generate comprehensive documentation from your codebase instantly

🎨

Highly Customizable

Choose from dozens of styling options, badges, and templates

🌐

Language Agnostic

Works with any programming language or framework

🤖

Multi-LLM Support

Compatible with OpenAI, Ollama, Anthropic, and Google Gemini

Quick Start

1. Install README-AI

pip install readmeai

2. Generate Documentation

readmeai --repository --output README-AI.md
\ No newline at end of file +
Skip to content

readme-ai

Your AI-Powered Documentation Assistant

Modern documentation generator combining advanced AI with robust data processing

Getting Started → View on GitHub →
GitHub Actions PyPI Version Downloads License
🚀

Automated Documentation

Generate comprehensive documentation from your codebase instantly

🎨

Highly Customizable

Choose from dozens of styling options, badges, and templates

🌐

Language Agnostic

Works with any programming language or framework

🤖

Multi-LLM Support

Compatible with OpenAI, Ollama, Anthropic, and Google Gemini

Quick Start

1. Install README-AI

pip install readmeai

2. Generate Documentation

readmeai --repository --output README-AI.md
\ No newline at end of file diff --git a/llms/anthropic/index.html b/llms/anthropic/index.html index 26dcaee6..a4643587 100644 --- a/llms/anthropic/index.html +++ b/llms/anthropic/index.html @@ -101,4 +101,4 @@ 2. **Model Not Found**: Make sure that the required LLM model is properly pulled using the `ollama pull` command. 3. **Permission Issues**: Ensure you have the necessary permissions to run commands with Ollama. You may need administrative rights on your system. -For further help, you can [open an issue](https://github.com/eli64s/readme-ai/issues) on GitHub or refer to the [official documentation](https://eli64s.github.io/readme-ai/). -->
\ No newline at end of file +For further help, you can [open an issue](https://github.com/eli64s/readme-ai/issues) on GitHub or refer to the [official documentation](https://eli64s.github.io/readme-ai/). -->
\ No newline at end of file diff --git a/llms/google_gemini/index.html b/llms/google_gemini/index.html index 37722319..87ade97b 100644 --- a/llms/google_gemini/index.html +++ b/llms/google_gemini/index.html @@ -22,4 +22,4 @@ ## Best Practices - Gemini models excel at understanding context and generating coherent text. -- Ensure you have the necessary API credentials set up. -->
\ No newline at end of file +- Ensure you have the necessary API credentials set up. -->
\ No newline at end of file diff --git a/llms/index.html b/llms/index.html index 9fa2e81c..d0c5d6c6 100644 --- a/llms/index.html +++ b/llms/index.html @@ -53,4 +53,4 @@ ``` - -->
\ No newline at end of file + -->
\ No newline at end of file diff --git a/llms/offline_mode/index.html b/llms/offline_mode/index.html index edbe14ae..5011eb80 100644 --- a/llms/offline_mode/index.html +++ b/llms/offline_mode/index.html @@ -21,4 +21,4 @@ ???+ note - Use offline mode for quick boilerplate generation or when you don't have internet access. - - Customize the generated README manually after generation. -->
\ No newline at end of file + - Customize the generated README manually after generation. -->
\ No newline at end of file diff --git a/llms/ollama/index.html b/llms/ollama/index.html index 81bd7765..9e5d0f00 100644 --- a/llms/ollama/index.html +++ b/llms/ollama/index.html @@ -28,4 +28,4 @@ ???+ note - - Slower README generation times may be experienced when using Ollama compared to cloud-based services. -->
\ No newline at end of file + - Slower README generation times may be experienced when using Ollama compared to cloud-based services. -->
\ No newline at end of file diff --git a/llms/openai/index.html b/llms/openai/index.html index bd12d603..f938d0b9 100644 --- a/llms/openai/index.html +++ b/llms/openai/index.html @@ -23,4 +23,4 @@ ## Best Practices - Use `gpt-3.5-turbo` for faster generation and lower costs. -- Use `gpt-4` or `gpt-4-turbo` for more complex projects or when you need higher accuracy. -->
\ No newline at end of file +- Use `gpt-4` or `gpt-4-turbo` for more complex projects or when you need higher accuracy. -->
\ No newline at end of file diff --git a/philosophy/index.html b/philosophy/index.html index c0c2a266..15bd2112 100644 --- a/philosophy/index.html +++ b/philosophy/index.html @@ -49,4 +49,4 @@ G --> H H --> N N --> S - S --> X
\ No newline at end of file + S --> X
\ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index bb51ab59..807ea5b0 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,126 +2,126 @@ https://docs.readme-ai.com/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/cli/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/contributing/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/faq/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/philosophy/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/troubleshooting/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/why/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/blog/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/configuration/badges/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/configuration/emojis/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/configuration/header/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/configuration/project_logo/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/configuration/table_of_contents/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/examples/gallery/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/examples/use_cases/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/guides/best_practices/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/guides/custom_templates/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/guides/markdown/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/anthropic/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/google_gemini/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/offline_mode/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/ollama/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/llms/openai/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/cli/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/docker/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/environment/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/installation/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/prerequisites/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/python/ - 2024-10-25 + 2024-10-27 https://docs.readme-ai.com/usage/streamlit/ - 2024-10-25 + 2024-10-27 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 52dd06519d9a3438c977b43e90e71074d7559af8..b71e4032c531bed7dd37b3cc8db8d270447f9327 100644 GIT binary patch delta 31 mcmX@ae2AG{zMF%ip-FZkyBw22!bbJUj2tN^`9nka85jVJBM2J+ delta 31 ncmX@ae2AG{zMF%i;l9*Fb~&aEj2qP_GjdG*@%VKJKLY~*pp6P( diff --git a/troubleshooting/index.html b/troubleshooting/index.html index 6887a732..96fa38d5 100644 --- a/troubleshooting/index.html +++ b/troubleshooting/index.html @@ -9,4 +9,4 @@

Viewing the Version

When seeking help, it's important to determine the version of readmeai that you're using — sometimes the problem is already solved in a newer version.

To check the installed version:

❯ readmeai --version

The following are also valid:

❯ readmeai -V
 ❯ readmeai pip --version
-

Open an issue on GitHub

The issue tracker on GitHub is a good place to report bugs and request features. Make sure to search for similar issues first, as it is common for someone else to encounter the same problem.

FAQ

See the FAQ for answers to common questions and troubleshooting tips.

\ No newline at end of file +

Open an issue on GitHub

The issue tracker on GitHub is a good place to report bugs and request features. Make sure to search for similar issues first, as it is common for someone else to encounter the same problem.

FAQ

See the FAQ for answers to common questions and troubleshooting tips.

\ No newline at end of file diff --git a/usage/cli/index.html b/usage/cli/index.html index fc267dc6..6efb7823 100644 --- a/usage/cli/index.html +++ b/usage/cli/index.html @@ -30,4 +30,4 @@ --image LLM \ --emojis

For a full list of options, run:

readmeai --help
-

See the Configuration documentation guide for detailed examples and explanations of each option.

Tips for Effective Usage

  1. Choose the right LLM: Different LLMs may produce varying results. Experiment to find the best fit for your project.
  2. Adjust temperature: Lower values (e.g., 0.1) produce more focused output, while higher values (e.g., 0.8) increase creativity.
  3. Use custom prompts: For specialized projects, consider using custom prompts to guide the AI's output.
  4. Review and edit: Always review the generated README and make necessary adjustments to ensure accuracy and relevance.

Troubleshooting

If you encounter any issues:

  1. Ensure you have the latest version of readme-ai installed.
  2. Check your API credentials if using OpenAI or Google Gemini.
  3. For Ollama, make sure the Ollama service is running locally.
  4. Consult the FAQ or open an issue for additional support.
\ No newline at end of file +

See the Configuration documentation guide for detailed examples and explanations of each option.

Tips for Effective Usage

  1. Choose the right LLM: Different LLMs may produce varying results. Experiment to find the best fit for your project.
  2. Adjust temperature: Lower values (e.g., 0.1) produce more focused output, while higher values (e.g., 0.8) increase creativity.
  3. Use custom prompts: For specialized projects, consider using custom prompts to guide the AI's output.
  4. Review and edit: Always review the generated README and make necessary adjustments to ensure accuracy and relevance.

Troubleshooting

If you encounter any issues:

  1. Ensure you have the latest version of readme-ai installed.
  2. Check your API credentials if using OpenAI or Google Gemini.
  3. For Ollama, make sure the Ollama service is running locally.
  4. Consult the FAQ or open an issue for additional support.
\ No newline at end of file diff --git a/usage/docker/index.html b/usage/docker/index.html index e74ed8f4..d29c94bd 100644 --- a/usage/docker/index.html +++ b/usage/docker/index.html @@ -25,4 +25,4 @@

Look for the container with ID abcdef123456.

2. Stop the Container

Stop the container using its ID.

docker stop abcdef123456

3. Remove the Container

Remove the container using its ID.

docker rm abcdef123456

4. Remove the Image

Remove the Docker image from your system.

docker rmi zeroxeli/readme-ai:latest
-

Troubleshooting

  1. If you encounter permission issues, ensure your user has the right permissions to run Docker commands.
  2. If the container fails to start, check that your OPENAI_API_KEY is correctly set and valid.
  3. For network-related issues, verify your internet connection and firewall settings.

For more detailed troubleshooting, refer to the official Docker documentation or open an issue on GitHub.

\ No newline at end of file +

Troubleshooting

  1. If you encounter permission issues, ensure your user has the right permissions to run Docker commands.
  2. If the container fails to start, check that your OPENAI_API_KEY is correctly set and valid.
  3. For network-related issues, verify your internet connection and firewall settings.

For more detailed troubleshooting, refer to the official Docker documentation or open an issue on GitHub.

\ No newline at end of file diff --git a/usage/environment/index.html b/usage/environment/index.html index 14529abf..f9f1c161 100644 --- a/usage/environment/index.html +++ b/usage/environment/index.html @@ -12,4 +12,4 @@

 Ollama

1. Pull your preferred language model from the Ollama server. 

ollama pull <model_name>:<model_version>
For example, to pull the mistral model: 
ollama pull mistral:latest
2. Set the OLLAMA_HOST environment variable and start the Ollama server. 
export OLLAMA_HOST=127.0.0.1 && ollama serve
-

Unsupported Language Models

If your preferred LLM API is not supported, open an issue or submit a pull request and we'll review the request!

\ No newline at end of file +

Unsupported Language Models

If your preferred LLM API is not supported, open an issue or submit a pull request and we'll review the request!

\ No newline at end of file diff --git a/usage/installation/index.html b/usage/installation/index.html index bb65ce6d..78221557 100644 --- a/usage/installation/index.html +++ b/usage/installation/index.html @@ -17,4 +17,4 @@ readmeai -V

You should see the installed version of readmeai displayed in the output:

readmeai version 0.5.99
-
\ No newline at end of file +
\ No newline at end of file diff --git a/usage/prerequisites/index.html b/usage/prerequisites/index.html index 83025961..1b00a89a 100644 --- a/usage/prerequisites/index.html +++ b/usage/prerequisites/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

Prerequisites

System Requirements

  • Python: 3.9+
  • Package Manager/Container: pip, pipx, uv, or docker.

Supported Sources

The following git hosting services are supported for source code retrieval, along with your local file system:

If your Git provider is not listed, open an issue or submit a pull request to add support for additional platforms.

Supported LLM APIs

To enable the full functionality of readmeai, an account and API key are required for one of the following providers:

  • OpenAI: Recommended for general use. Requires an OpenAI account and API key.
  • Ollama: Free and open-source. No API key required.
  • Anthropic: Requires an Anthropic account and API key.
  • Google Gemini: Requires a Google Cloud account and API key.
  • Offline Mode: Generates a boilerplate README without making API calls.

For more information on setting up an API key, refer to the provider's documentation.

\ No newline at end of file +
Skip to content

Prerequisites

System Requirements

  • Python: 3.9+
  • Package Manager/Container: pip, pipx, uv, or docker.

Supported Sources

The following git hosting services are supported for source code retrieval, along with your local file system:

If your Git provider is not listed, open an issue or submit a pull request to add support for additional platforms.

Supported LLM APIs

To enable the full functionality of readmeai, an account and API key are required for one of the following providers:

  • OpenAI: Recommended for general use. Requires an OpenAI account and API key.
  • Ollama: Free and open-source. No API key required.
  • Anthropic: Requires an Anthropic account and API key.
  • Google Gemini: Requires a Google Cloud account and API key.
  • Offline Mode: Generates a boilerplate README without making API calls.

For more information on setting up an API key, refer to the provider's documentation.

\ No newline at end of file diff --git a/usage/python/index.html b/usage/python/index.html index 97dec5a8..0198769d 100644 --- a/usage/python/index.html +++ b/usage/python/index.html @@ -26,4 +26,4 @@ 2. **Navigate to the directory:** 
cd readme-ai
3. **Install dependencies:** 
pip install -r setup/requirements.txt
4. **Run the application:** 
python -m readmeai.cli.main --repository https://github.com/username/repository
-

Troubleshooting

  1. Permission Issues
  2. Use sudo for system-wide installation on Unix systems
  3. Use a virtual environment to avoid permission issues

  4. Ensure Python is properly added to your system's PATH

  5. Package Installation Problems

  6. Update pip: python -m pip install --upgrade pip
  7. Try installing in a fresh virtual environment

  8. Check Python version compatibility (3.9+ required)

  9. API Key Issues

  10. Verify API key is correctly set in environment variables
  11. Check API key permissions and quotas

  12. Ensure no leading/trailing whitespace in API key

  13. Execution Errors

  14. Check internet connectivity for API calls
  15. Verify repository URL/path is accessible
  16. Ensure sufficient disk space for output

For additional help: - Check the GitHub Issues - Visit the Official Documentation - Start a Discussion

\ No newline at end of file +

Troubleshooting

  1. Permission Issues
  2. Use sudo for system-wide installation on Unix systems
  3. Use a virtual environment to avoid permission issues

  4. Ensure Python is properly added to your system's PATH

  5. Package Installation Problems

  6. Update pip: python -m pip install --upgrade pip
  7. Try installing in a fresh virtual environment

  8. Check Python version compatibility (3.9+ required)

  9. API Key Issues

  10. Verify API key is correctly set in environment variables
  11. Check API key permissions and quotas

  12. Ensure no leading/trailing whitespace in API key

  13. Execution Errors

  14. Check internet connectivity for API calls
  15. Verify repository URL/path is accessible
  16. Ensure sufficient disk space for output

For additional help: - Check the GitHub Issues - Visit the Official Documentation - Start a Discussion

\ No newline at end of file diff --git a/usage/streamlit/index.html b/usage/streamlit/index.html index 35e8ae28..b7d54767 100644 --- a/usage/streamlit/index.html +++ b/usage/streamlit/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

 Streamlit

Try readme-ai directly in your browser on Streamlit Cloud, no installation required!

Open In Streamlit

For more information about the Streamlit app, see the readme-ai-streamlit GitHub repository.

Streamlit App Status

The Streamlit web app for readme-ai is not actively developed and may not be up-to-date with the latest features. For the most recent version of readme-ai, please use the command-line interface.

\ No newline at end of file +
Skip to content

 Streamlit

Try readme-ai directly in your browser on Streamlit Cloud, no installation required!

Open In Streamlit

For more information about the Streamlit app, see the readme-ai-streamlit GitHub repository.

Streamlit App Status

The Streamlit web app for readme-ai is not actively developed and may not be up-to-date with the latest features. For the most recent version of readme-ai, please use the command-line interface.

\ No newline at end of file diff --git a/why/index.html b/why/index.html index a8b06fe8..b05a403b 100644 --- a/why/index.html +++ b/why/index.html @@ -5,4 +5,4 @@ "name": "README-AI", "url": "https://docs.readme-ai.com/" } -
Skip to content

Why use README-AI?

README-AI is a powerful tool that automates the process of creating detailed, structured README files for your projects. By analyzing your codebase, README-AI generates comprehensive documentation that covers all essential aspects of your project, from installation instructions to usage examples.

Automated Documentation Generation

Readme-ai harnesses the power of artificial intelligence to automatically generate detailed, structured README files for your projects. By analyzing your codebase, Readme-ai creates documentation that is:

  • Comprehensive: Covers all essential aspects of your project, from installation instructions to usage examples.
  • Consistent: Maintains a uniform structure across all your projects, enhancing readability and professionalism.

Time-Saving and Efficient

  • Focus on Coding: Spend more time writing code and less time worrying about documentation.
  • Quick Setup: Get started with minimal configuration, allowing you to generate a README in minutes.
  • Customizable Templates: Fine-tune the output to match your project's specific needs and your personal style.

Enhanced Project Visibility

  • Professional Appearance: Engage potential users and contributors with polished, well-structured documentation.
  • Comprehensive Overview: Provide a clear, concise summary of your project, making it easier for others to understand and use.
  • SEO-Friendly: Generated READMEs are optimized for search engines, improving your project's discoverability.

Integration and Flexibility

  • Extensible: Customize and extend readme-ai to fit your specific documentation needs.
  • Multiple AI Backends: Choose from various AI providers (OpenAI, Ollama, Google Gemini) or use the offline mode for sensitive projects.
  • Language Agnostic: Works with a wide range of programming languages and project types, ensuring compatibility with your existing codebase.

Community-Driven Development

  • Open Source: Benefit from and contribute to a growing ecosystem of documentation tools and best practices.
  • Continuous Improvement: Regular updates and improvements driven by community feedback and contributions.
  • Shared Knowledge: Learn from and contribute to a gallery of exemplary READMEs generated by the community.

Key Features

  1. Flexible README Generation: Combines robust repository context extraction with generative AI to create detailed and accurate README files.

  2. Customizable Output: Offers numerous CLI options for tailoring the README to your project's needs:

    • Badge styles and colors

    • Header designs

    • Table of contents styles

    • Project logos

  3. Language Agnostic: Works with a wide range of programming languages and project types, automatically detecting and summarizing key aspects of your codebase.

  4. Project Analysis: Automatically extracts and presents important information about your project:

    • Directory structure
    • File summaries
    • Dependencies
    • Setup instructions

  5. Multi-LLM Support: Compatible with various language model APIs, including:

    • OpenAI
    • Ollama
    • Anthropic
    • Google Gemini
    • Offline Mode

  6. Offline Mode: Generate a basic README structure without requiring an internet connection or API calls.

  7. Markdown Expertise: Leverages best practices in Markdown formatting for clean, professional-looking documentation.

\ No newline at end of file +
Skip to content

Why use README-AI?

README-AI is a powerful tool that automates the process of creating detailed, structured README files for your projects. By analyzing your codebase, README-AI generates comprehensive documentation that covers all essential aspects of your project, from installation instructions to usage examples.

Automated Documentation Generation

Readme-ai harnesses the power of artificial intelligence to automatically generate detailed, structured README files for your projects. By analyzing your codebase, Readme-ai creates documentation that is:

  • Comprehensive: Covers all essential aspects of your project, from installation instructions to usage examples.
  • Consistent: Maintains a uniform structure across all your projects, enhancing readability and professionalism.

Time-Saving and Efficient

  • Focus on Coding: Spend more time writing code and less time worrying about documentation.
  • Quick Setup: Get started with minimal configuration, allowing you to generate a README in minutes.
  • Customizable Templates: Fine-tune the output to match your project's specific needs and your personal style.

Enhanced Project Visibility

  • Professional Appearance: Engage potential users and contributors with polished, well-structured documentation.
  • Comprehensive Overview: Provide a clear, concise summary of your project, making it easier for others to understand and use.
  • SEO-Friendly: Generated READMEs are optimized for search engines, improving your project's discoverability.

Integration and Flexibility

  • Extensible: Customize and extend readme-ai to fit your specific documentation needs.
  • Multiple AI Backends: Choose from various AI providers (OpenAI, Ollama, Google Gemini) or use the offline mode for sensitive projects.
  • Language Agnostic: Works with a wide range of programming languages and project types, ensuring compatibility with your existing codebase.

Community-Driven Development

  • Open Source: Benefit from and contribute to a growing ecosystem of documentation tools and best practices.
  • Continuous Improvement: Regular updates and improvements driven by community feedback and contributions.
  • Shared Knowledge: Learn from and contribute to a gallery of exemplary READMEs generated by the community.

Key Features

  1. Flexible README Generation: Combines robust repository context extraction with generative AI to create detailed and accurate README files.

  2. Customizable Output: Offers numerous CLI options for tailoring the README to your project's needs:

    • Badge styles and colors

    • Header designs

    • Table of contents styles

    • Project logos

  3. Language Agnostic: Works with a wide range of programming languages and project types, automatically detecting and summarizing key aspects of your codebase.

  4. Project Analysis: Automatically extracts and presents important information about your project:

    • Directory structure
    • File summaries
    • Dependencies
    • Setup instructions

  5. Multi-LLM Support: Compatible with various language model APIs, including:

    • OpenAI
    • Ollama
    • Anthropic
    • Google Gemini
    • Offline Mode

  6. Offline Mode: Generate a basic README structure without requiring an internet connection or API calls.

  7. Markdown Expertise: Leverages best practices in Markdown formatting for clean, professional-looking documentation.

\ No newline at end of file