You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Let's begin by exploring various customization options and styles supported by ReadmeAI:
80
-
81
79
### Customize Your README
82
80
81
+
Let's begin by exploring various customization options and styles supported by ReadmeAI:
82
+
83
83
<divalign="left">
84
84
<h6>Header Styles</h6>
85
85
<table>
@@ -284,18 +284,18 @@ Let's begin by exploring various customization options and styles supported by R
284
284
285
285
<details><summary><strong>꩜ Expand to view more!</strong></summary><br>
286
286
287
-
| <h3>Project Introduction</h3> <ul><li>This section captures your project's essence and value proposition. </li><li>The prompt template used to generate this section can be viewed [here][prompts]. </li></ul> |
287
+
| <h3>Project Introduction</h3> <ul><li>This section captures your project's essence and value proposition. </li><li>The prompt template used to generate this section can be viewed [here][prompts.toml]. </li></ul> |
288
288
| :--- |
289
289
|![][project-overview]|
290
290
291
-
| <h3>Features Table</h3> <ul><li>Detailed feature breakdown and technical capabilities. </li><li>The prompt template used to generate this section can be viewed [here][prompts]. </li></ul> |
291
+
| <h3>Features Table</h3> <ul><li>Detailed feature breakdown and technical capabilities. </li><li>The prompt template used to generate this section can be viewed [here][prompts.toml]. </li></ul> |
292
292
| :--- |
293
293
|![][features-table]|
294
294
295
295
| <h3>Project Structure</h3> <ul><li>Visual representation of your project's directory structure. </li><li>The tree is generated using [pure Python][tree.py] and embedded in a code block. </li></ul> |
296
296
| :--- |
297
297
|![][project-structure]|
298
-
| <h3>Project Index</h3> <ul><li>Summarizes key modules of the project, which are also used as context for downstream [prompts][prompts]. </li></ul> |
298
+
| <h3>Project Index</h3> <ul><li>Summarizes key modules of the project, which are also used as context for downstream [prompts.toml][prompts.toml]. </li></ul> |
299
299
|![][project-index]|
300
300
301
301
| <h3>Getting Started Guides</h3> <ul><li>Dependencies and system requirements are extracted from the codebase during preprocessing. </li><li>The [parsers][readmeai.parsers] handle most of the heavy lifting here. </li></ul> |
@@ -312,7 +312,7 @@ Let's begin by exploring various customization options and styles supported by R
@@ -677,7 +677,7 @@ Using nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12
677
677
> [!TIP]
678
678
><sub>Nox is an automation tool fortesting applicationsin multiple environments. This helps ensure your project is compatible with across Python versions and environments.</sub>
0 commit comments