rework README.md #227
rework README.md #227
Conversation
guijan
force-pushed
the
update-readme
branch
3 times, most recently
from
fb51bf7 to
894bef6
Compare
guijan
force-pushed
the
update-readme
branch
from
894bef6 to
390d6fb
Compare
|
Rebased with a46dc37's changes. |
|
This PR has a number of stylistic changes I don't care for, especially the giant logo and the newlines. Swapping to ``` to make the build instructions easier to copy seems fine, as well as the subheaders. I'm also not keen on offering build instructions for a bunch of different Linux distributions, which is why I currently avoided mentioning Linux at all in the README. I don't want to end up in a scenario where I'm worrying about or getting PRs about the long tail of distros out there. I'm okay adding instructions for some common distro, probably Ubuntu since then it just matches CI and we know it will work. |
|
Oh, I also don't think the build instructions should be for a release version. That should be left to the default (debugoptimized) with a note about how to create a release build. Anyone building from source, at least on Windows and Mac, is likely looking to contribute to development, and anyone who doesn't read carefully enough to see that note should be using prebuilt binaries. |
Replace the links and text near the top with a briefer quick links section. The IRC wasn't displayed or linked properly because Markdown doesn't support non-HTTP links, display the URL instead of trying to link it. Break lines at 80 columns. You can split lines in Markdown like code. Replace the deprecated `meson build_static` Meson construct with `meson setup build_static`. Remove manual Ninja calls, Meson abstracts it away. Remove unnecessary `meson compile -C build_static` step in the macOS instructions because the `meson test -C build_static` line after it will ensure Aegisub is compiled. Rename "OS X" to "macOS," which is the new name Apple uses for their OS. Syntax highlight code blocks. Separate compilation instructions into Prerequisites/Building/Installer sections and name sections uniquely so they can be linked. Add Linux intructions. Sort dependencies alphabetically.
"newlines" change missing
|
Applied most of the changes, but the part about newlines is missing. Do you mean you don't want lines split at 80 characters, or do you mean something about the escaped newlines inside the code blocks in the instructions? |
See the commit message for details.
Fixes #172.
I still want to add more Linux/Unix systems (maybe about 3 total), review the text more carefully, and the Windows instructions still need a bit of work according to #196.
Edit: I couldn't even get Aegisub to compile on more than 1 system.
You can see how the new README.md looks like at my fork: https://github.com/guijan/Aegisub/tree/update-readme