rework README.md #227
Open
rework README.md #227
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
guijan
force-pushed
the
update-readme
branch
2 times, most recently
from
22849e9 to
fb51bf7
Compare
Display the logo. Fix small grammar mistakes such as commas outside quotes. 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. Use release builds in the compilation instructions.
guijan
force-pushed
the
update-readme
branch
from
fb51bf7 to
894bef6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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