Builditluc / wiki-tui

A simple and easy to use Wikipedia Text User Interface
https://wiki-tui.net/
MIT License
405 stars 14 forks source link

Simplify Readme #137

Closed Builditluc closed 1 year ago

Builditluc commented 1 year ago

It looks like the current Readme file has a lot of preview images, which may make it difficult for users to quickly find the information they need. Additionally, the link to the website is not prominently displayed.

We need to reduce the number of preview images in the Readme and make the link to the website more prominent. This will make it easier for users to get started with the project and find additional resources. I'd like to convert the HTML in the logo area to Markdown.

We also need to update the acknowledgments section: remove the reference to best-readme-template, as it is no longer being used in the project and add references to the Rust programming language and the MkDocs documentation.

Checklist

Builditluc commented 1 year ago

Since the logo and the corresponding project name and description are all horizontally centered, we cannot use markdown for this and as such, have to leave it in html.