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
Copy file name to clipboardExpand all lines: README.md
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -377,7 +377,7 @@ This project is under development with an opinionated setup. It's vital to revie
377
377
<br>
378
378
379
379
<palign="right">
380
-
<ahref="#top"><b>🔝 Return </b></a>
380
+
<ahref="#top"><b>Return </b></a>
381
381
</p>
382
382
383
383
---
@@ -547,13 +547,13 @@ To generate a *README.md* file, use the `readmeai` command in your terminal, alo
547
547
548
548
To customize the README file generation process, you can modify the project's [configuration file:](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml)
549
549
550
-
-[*api*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - OpenAI language model API configuration settings.
551
-
-[*base_urls*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Base URLs for supported remote repository platforms.
552
-
-[*cli*]((https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - CLI option settings used by the *readme-ai* application.)
553
-
-[*git*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Default git repository settings used if no repository is provided.
554
-
-[*paths*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Directory paths and files used by the *readme-ai* application.
555
-
-[*prompts*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Large language model prompts used to generate the README file.
556
-
-[*md*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Dynamic Markdown section code templates used to build the README file.
550
+
-**api**: OpenAI language model API configuration settings.
551
+
-**base_urls**: Base URLs for supported remote repository platforms.
552
+
-**cli**: CLI option settings used by the *readme-ai* application.
553
+
-**git**: Default git repository settings used if no repository is provided.
554
+
-**paths**: Directory paths and files used by the *readme-ai* application.
555
+
-**prompts**: Large language model prompts used to generate the README file.
556
+
-**md**: Dynamic Markdown section code templates used to build the README file.
You can also use the `short flags` for the CLI options above. In this example we are naming the output file `readme-ai.md`, setting the repository URL to the *readme-ai* repository, using the `flat-square` badge style, and removing emojis from the README file header names.
581
+
You can also use the `short flags` for the CLI options above.
582
+
583
+
In this example we name the output file `readme-ai.md`, set the repo URL to *readme-ai*, use the `flat-square` badge style, and remove emojis from the README file header names.
Additionally, you can run readme-ai in offline mode, or without an API key! This option is useful for spinning up a baseline README.md file that still contains your project's metadata.
0 commit comments