Skip to content

Commit

Permalink
Fix html table formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eli64s
eli64s committed Sep 26, 2023
1 parent 0642e85 commit 653a2c6
Show file tree
Hide file tree
Showing 3 changed files with 187 additions and 155 deletions.
338 changes: 185 additions & 153 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="left">
<div align="right">

[![fr](https://img.shields.io/badge/fr-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md)
[![zh-CN](https://img.shields.io/badge/zh--CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/README-zh-CN.md)
[![zh-CN](https://img.shields.io/badge/zh--CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-zh-CN.md)
[![fr](https://img.shields.io/badge/FR-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md)
</div>

<div align="center">
Expand Down Expand Up @@ -89,21 +89,22 @@ This project is currently under development and has an opinionated configuration

## 🤖 Features

<br>
<div>
<details>
<summary>
<h2 style="margin-top: 1em;">❶ Project Badges</h2>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❶ Project Badges</span>
</summary>
<table>
<tr>
<td>
<h4><i>Project Slogan and Badges</i></h4>
<p>
‣ A slogan to highlight your poject is generated by <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/conf/conf.toml#L56">prompting</a> OpenAI's GPT engine.
</p>
</p>
<p>
‣ Codebase dependencies and metadata are visualized using <a href="https://shields.io/">Shields.io</a> badges.
</p>
<!--<p>‣ Badges are sorted by hex code, displayed from light to dark hues.</p>-->
</td>
</tr>
<tr>
Expand All @@ -113,177 +114,208 @@ This project is currently under development and has an opinionated configuration
</tr>
</table>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">Codebase Documentation</h2>
</summary>
<table>
<tr>
<h4><i>Directory Tree and File Summaries</i></h4>
<p>
‣ Your project's directory structure is visualized using a custom tree function.
</p>
<p>
‣ Each file in the codebase is summarized by OpenAI's <i>GPT</i> model.
</p>
</tr>
<tr>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/repository-tree.png" alt="repository-tree" />
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/code-summaries.png" alt="code-summaries" />
</td>
</tr>
</table>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">❸ Overview and Features Table</h2>
</summary>
<table>
<tr>
<td>
<h4><i>Prompted Text Generation</i></h4>
<p>
‣ An overview paragraph and features table are generated using <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/conf/conf.toml#L31">detailed prompts</a>, embedded with project metadata.
</p>
</td>
</tr>
<tr>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/feature-table.png" alt="feature-table" />
</td>
</tr>
</table>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">❹ Dynamic Usage Instructions</h2>
</summary>
<table>
<tr>
<td>
<h4><i>Installation, Running, and Test</i></h4>
<p>
‣ 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/conf/language_setup.toml">language_setup.toml</a> configuration file.
</p>
</td>
</tr>
<tr>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/usage-instructions.png" alt="usage-instructions" />
</td>
</tr>
</table>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">❺ Contributing Guidelines and more!</i></h2>
</summary>
<table>
<tr>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/roadmap.png" alt="roadmap" />
</td>
</tr>
<br>
<tr>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/license.png" alt="license" />
</td>
</tr>
</table>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">❻ Custom Templates - coming soon!</h2>
</summary>
<p>‣ Developing CLI option letting users select from a variety of README styles</p>
<p>‣ Templates for use-cases such as data, machine learning, web development, and more!</p>
</details>
<details>
<summary>
<h2 style="margin-top: 1em;">❼ Example README Files</h2>
</summary>
<table>
<thead>
<tr>
<th></th>
<th>Output File</th>
<th>Repository</th>
<th>Languages</th>
</tr>
</thead>
<tbody>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❷ Codebase Documentation</span>
</summary>
<table>
<tr>
<td>1️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-python.md">readme-python.md</a></td>
<td><a href="https://github.com/eli64s/readme-ai">readme-ai</a></td>
<td>Python</td>
<td colspan="2">
<h4><i>Directory Tree and File Summaries</i></h4>
</td>
</tr>
<tr>
<td>2️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/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>
<td colspan="2">
<p>‣ Your project's directory structure is visualized using a custom tree function.</p>
<p>‣ Each file in the codebase is summarized by OpenAI's <i>GPT</i> model.</p>
</td>
</tr>
<tr>
<td>3️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/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>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/repository-tree.png" alt="repository-tree" />
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/code-summaries.png" alt="code-summaries" />
</td>
</tr>
</table>
</details>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"></span> ❸ Overview and Features Table</span>
</summary>
<table>
<tr>
<td>4️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/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>
<td>
<h4><i>Prompted Text Generation</i></h4>
<p>
‣ An overview paragraph and features table are generated using <a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/conf/conf.toml#L31">detailed prompts</a>, embedded with project metadata.
</p>
</td>
</tr>
<tr>
<td>5️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md">readme-rust-c.md</a></td>
<td><a href="https://github.com/DownWithUp/CallMon">rust-c-app</a></td>
<td>C, Rust</td>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/feature-table.png" alt="feature-table" />
</td>
</tr>
</table>
</details>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❹ Dynamic Usage Instructions</span><br>
</summary>
<table>
<tr>
<td>6️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-go.md">readme-go.md</a></td>
<td><a href="https://github.com/olliefr/docker-gs-ping">go-docker-app</a></td>
<td>Go</td>
<td>
<h4><i>Installation, Running, and Test</i></h4>
<p>
‣ 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/conf/language_setup.toml">language_setup.toml</a> configuration file.
</p>
</td>
</tr>
<tr>
<td>7️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md">readme-java.md</a></td>
<td><a href="https://github.com/avjinder/Minimal-Todo">java-minimal-todo</a></td>
<td>Java</td>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/usage-instructions.png" alt="usage-instructions" />
</td>
</tr>
</table>
</details>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❺ Contributing Guidelines and more!</span><br>
</summary>
<table>
<tr>
<td>8️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md">readme-fastapi-redis.md</a></td>
<td><a href="https://github.com/FerrariDG/async-ml-inference">async-ml-inference</a></td>
<td>Python, FastAPI, Redis</td>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/roadmap.png" alt="roadmap" />
</td>
</tr>
<br>
<tr>
<td>9️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md">readme-mlops.md</a></td>
<td><a href="https://github.com/GokuMohandas/mlops-course">mlops-course</a></td>
<td>Python, Jupyter</td>
<td>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/license.png" alt="license" />
</td>
</tr>
</table>
</details>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❻ Custom Templates - coming soon</span><br>
</summary>
<table>
<tr>
<td>🔟</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-pyflink.md">readme-pyflink.md</a></td>
<td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td>
<td>PyFlink</td>
<td>
<ul>
<li>Developing CLI option letting users select from a variety of README styles</li>
<li>Templates for use-cases such as data, machine learning, web development, and more!</li>
</ul>
</td>
</tr>
</tbody>
</table>
</details>
</table>
</details>
</div>
<br>
<div>
<details>
<summary style="display: flex; align-items: center;">
<span style="font-size: 1.5em;"> ❼ Example README Files</span><br>
</summary>
<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/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/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/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/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>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md">readme-rust-c.md</a></td>
<td><a href="https://github.com/DownWithUp/CallMon">rust-c-app</a></td>
<td>C, Rust</td>
</tr>
<tr>
<td>6️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-go.md">readme-go.md</a></td>
<td><a href="https://github.com/olliefr/docker-gs-ping">go-docker-app</a></td>
<td>Go</td>
</tr>
<tr>
<td>7️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md">readme-java.md</a></td>
<td><a href="https://github.com/avjinder/Minimal-Todo">java-minimal-todo</a></td>
<td>Java</td>
</tr>
<tr>
<td>8️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md">readme-fastapi-redis.md</a></td>
<td><a href="https://github.com/FerrariDG/async-ml-inference">async-ml-inference</a></td>
<td>Python, FastAPI, Redis</td>
</tr>
<tr>
<td>9️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md">readme-mlops.md</a></td>
<td><a href="https://github.com/GokuMohandas/mlops-course">mlops-course</a></td>
<td>Python, Jupyter</td>
</tr>
<tr>
<td>🔟</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-pyflink.md">readme-pyflink.md</a></td>
<td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td>
<td>PyFlink</td>
</tr>
</tbody>
</table>
</details>
</div>
<br>

<p align="right">
<a href="#top"><b>🔝 Return</b></a>
</p>


---

## 👩‍💻 Usage
Expand Down
Loading

0 comments on commit 653a2c6

Please sign in to comment.