📝 Building from source instructions #20
Conversation
| @@ -8,7 +8,7 @@ | |||
| </h1> | |||
| <h4 align="center">A highly customizable snake clone made in Rust with the <a href="https://github.com/bevyengine/bevy">Bevy engine</a>, named after the Japanese word for snake, <ruby>蛇<rp>(</rp><rt>へび</rt><rp>)</rp></ruby>.</h4> | |||
|
|
|||
| ## Configuration | |||
| ## Configuration <a name="configuration"></a> | |||
There was a problem hiding this comment.
As far as I know, this isn't needed for GFM, renderers already generate links to headings in kebab-case.
There was a problem hiding this comment.
I had no idea, thanks for letting me know :)
|
|
||
| ## Building from source | ||
|
|
||
| You've taken interest in the project and would like to work on it or build your own Hebi from source, follow through these steps to get it up and running on your machine. |
There was a problem hiding this comment.
Feels a bit long-winded (literally!) Maybe split the sentence on the comma, and either:
- Make the first part a question;
- Add some preposition to the second part ("Then, follow through [...]", "Now, [...]" etc)
There was a problem hiding this comment.
Make the first part a question
It would sound better if it was a question, yes.
| cargo build --release | ||
| ``` | ||
|
|
||
| 5. You might want to [configure the game](#configuration) now that you've built it yourself |
There was a problem hiding this comment.
Might read better if you phrase it the other way around:
Now that you've built it yourself, you [...]
There was a problem hiding this comment.
Add some sort of punctuation to the instructions. I don't recall exactly, I think ";" is the correct one? Like so:
- List item;
- Another item;
- Last!
There was a problem hiding this comment.
I usually avoid punctuation when I'm listing things. But if this is not the standard, I'm happy to give it some punctuation bling.
There was a problem hiding this comment.
Yeah, a quick duckduckgo search landed me on what appears to be the standard when it comes to bullet point punctuation, but it's not semicolons, just a period. What do you think?
|
Alright, I got the merged in! I think I kind of screwed up though, I wanted to push some changes I made onto the PR before merging it, and I don't think it worked. 😞 (It didn't show up here.) Is that even possible? Anyhow, I made some adjustments and added a section on UPX. |
|
Oh no :( I was just about to upload the implemented suggestions. I pulled your changes and submitted the PR. |
Git works in mysterious ways. |
This addresses #18