From eb2a0b4778c633911303f3c00f87874f398b5180 Mon Sep 17 00:00:00 2001 From: Eli Date: Thu, 2 Jan 2025 02:30:56 -0600 Subject: [PATCH] Fix links. --- README.md | 50 +++++++++++++++++++++++----------------------- docs/docs/index.md | 2 +- pyproject.toml | 2 +- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 69d8f250..338a1d08 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

- ReadmeAI Logo + ReadmeAI Logo

@@ -28,7 +28,7 @@

-line break +line break ## Quick Links @@ -43,7 +43,7 @@ > [!IMPORTANT] > Explore the [Official Documentation][docs] for a complete list of features, customization options, and examples. -line break +line break ## Introduction @@ -72,14 +72,14 @@ This project aims to streamline the process of creating and maintaining document [readmeai-streamlit-demo][streamlit-demo] --> -line break +line break ## Features -Let's begin by exploring various customization options and styles supported by ReadmeAI: - ### Customize Your README +Let's begin by exploring various customization options and styles supported by ReadmeAI: +
Header Styles
@@ -284,18 +284,18 @@ Let's begin by exploring various customization options and styles supported by R
꩜ Expand to view more!
-|

Project Introduction

  • This section captures your project's essence and value proposition.
  • The prompt template used to generate this section can be viewed [here][prompts].
| +|

Project Introduction

  • This section captures your project's essence and value proposition.
  • The prompt template used to generate this section can be viewed [here][prompts.toml].
| | :--- | | ![][project-overview] | -|

Features Table

  • Detailed feature breakdown and technical capabilities.
  • The prompt template used to generate this section can be viewed [here][prompts].
| +|

Features Table

  • Detailed feature breakdown and technical capabilities.
  • The prompt template used to generate this section can be viewed [here][prompts.toml].
| | :--- | | ![][features-table] | |

Project Structure

  • Visual representation of your project's directory structure.
  • The tree is generated using [pure Python][tree.py] and embedded in a code block.
| | :--- | | ![][project-structure] | -|

Project Index

  • Summarizes key modules of the project, which are also used as context for downstream [prompts][prompts].
| +|

Project Index

  • Summarizes key modules of the project, which are also used as context for downstream [prompts.toml][prompts.toml].
| | ![][project-index] | |

Getting Started Guides

  • Dependencies and system requirements are extracted from the codebase during preprocessing.
  • The [parsers][readmeai.parsers] handle most of the heavy lifting here.
| @@ -312,7 +312,7 @@ Let's begin by exploring various customization options and styles supported by R
-line break +line break ## Getting Started @@ -602,7 +602,7 @@ Run the `readmeai` CLI in a Docker container: Try readme-ai directly in your browser on Streamlit Cloud, no installation required. -[][streamlit] +[](https://readme-ai.streamlit.app/) See the [readme-ai-streamlit][readme-ai-streamlit] repository on GitHub for more details about the application. @@ -648,7 +648,7 @@ If you installed the project from source with the bash script, run the following -line break +line break ### Testing @@ -677,7 +677,7 @@ Using nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12 > [!TIP] > Nox is an automation tool for testing applications in multiple environments. This helps ensure your project is compatible with across Python versions and environments. -line break +line break ## Configuration @@ -712,7 +712,7 @@ Visit the [Official Documentation][docs] for a complete guide on configuring and -line break +line break ## Example Gallery @@ -743,7 +743,7 @@ We invite developers to share their generated README files in our [Show & Tell][ Find additional README examples in our [examples directory][examples-directory] on GitHub. -line break +line break ## Roadmap @@ -795,8 +795,6 @@ A big shoutout to the projects below for their awesome work and open-source cont -line break - ## 🎗 License Copyright © 2023-2025 [readme-ai][readme-ai].
@@ -808,6 +806,8 @@ Released under the [MIT][license] license. +line break + [readme-ai]: https://github.com/eli64s/readme-ai @@ -875,14 +875,14 @@ Released under the [MIT][license] license. -[project-overview]: docs/docs/assets/img/project-overview/introduction.png -[features-table]: docs/docs/assets/img/features/features.png -[project-structure]: docs/docs/assets/img/project-structure/project-structure.png -[project-index]: docs/docs/assets/img/project-structure/project-index.png -[installation-steps]: docs/docs/assets/img/getting-started/installation-steps.png -[usage-guides]: docs/docs/assets/img/getting-started/usage-guides.png -[community-and-support]: docs/docs/assets/img/community/community-and-support.png -[contributing-guidelines]: docs/docs/assets/img/community/contributing-guidelines.png +[project-overview]: https://github.com/eli64s/readme-ai/blob/main/https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-overview/introduction.png?raw=true +[features-table]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/features/features.png +[project-structure]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-structure.png +[project-index]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-index.png +[installation-steps]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/installation-steps.png +[usage-guides]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/usage-guides.png +[community-and-support]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/community-and-support.png +[contributing-guidelines]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/contributing-guidelines.png [readmeai.parsers]: https://github.com/eli64s/readme-ai/tree/main/readmeai/parsers [tree.py]: https://github.com/eli64s/readme-ai/blob/main/readmeai/generators/tree.py [prompts.toml]: https://github.com/eli64s/readme-ai/blob/main/readmeai/config/settings/prompts.toml diff --git a/docs/docs/index.md b/docs/docs/index.md index de0f29ec..57d0892e 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -2,7 +2,7 @@
- readme-ai

diff --git a/pyproject.toml b/pyproject.toml index 4ba16a95..fdacadc9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "readmeai" -version = "0.6.0-rc.1" +version = "0.6.0-rc.2" description = "Automated README file generator, powered by AI." authors = ["Eli Salamie "] license = "MIT"