mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-17 23:27:49 -06:00
docs: turn the readme into a front page
The README ran 211 lines and 2,000 words: five commands with options, an 18-row download table, coverage figures and the build commands, all before the help. It now says what the project does, gives the line that installs for Windows and for the rest, shows it, lists the six ZIPs and the setups that install by command, and leads to the site, where the figures and every option live. The build commands sit in a closed block. No personal pronoun is left in its text.
This commit is contained in:
1 parent
47593c58d7
commit
16ec5fa2d2
11 files changed
+176
-428
No files matched your search
@@ -284,9 +284,9 @@ class EverySurfaceSaysWhy(unittest.TestCase):
|
||||
|
||||
def test_the_readme_rows_read_use_the_command(self):
|
||||
readme = (REPO_ROOT / "README.md").read_text(encoding="utf-8")
|
||||
row = next(line for line in readme.splitlines() if line.startswith("| KNULLI |"))
|
||||
self.assertIn(f"[Use the command]({SITE}get/knulli/)", row)
|
||||
self.assertIn("ZIPs are made for the setups most people download.", readme)
|
||||
line = next(text for text in readme.split("\n\n") if "ZIPs are made for the setups most people download." in text)
|
||||
self.assertIn(f"[KNULLI]({SITE}get/knulli/)", line)
|
||||
self.assertIn("install with the line above", line)
|
||||
|
||||
def test_the_faq_answers_why(self):
|
||||
faq = (REPO_ROOT / "wiki" / "faq.md").read_text(encoding="utf-8")
|
||||
|
||||
Reference in new issue
Block a user