search

tomaz / appledoc

Objective-c code Apple style documentation set generator.
http://gentlebytes.com
4.19k stars 644 forks source link

Instructions for M1 #662

Open v-kpheng opened 1 year ago

v-kpheng commented 1 year ago

Adds installation instructions for computers running on M1 silicon

v-kpheng commented 1 year ago

@tomaz, can you please review? Thanks!

tomaz commented 1 year ago

It's been many years since I last used a Mac, so have no experience with M chips. Instructions seem fine, however your branch is behind master, please rebase, then it can be merged.

v-kpheng commented 1 year ago

Thanks, @tomaz, for helping out. Much appreciated!

I checked the logs and I think it's up to date. See logs below.

bash-3.2$ git log -n 2
commit d314423815e5fe0b800a80b6ea15c15c302b4046 (HEAD -> instructions-for-m1, origin/instructions-for-m1)
Author: Kongpheng Nanthavongsa <Kongpheng.Nanthavongsa@vonage.com>
Date:   Fri Jan 27 23:23:27 2023 -0800

    m1

commit bbb0129aa3e92ea68beae16d6b0b6fd4ac6345e2 (upstream/master, origin/master, master)
Author: Adam Norberg <norberg@google.com>
Date:   Thu Jul 15 18:15:09 2021 -0700

    Fix headers in CommentsFormattingStyle.markdown

    Github-flavored Markdown only recognizes headers if there's a space between the `#` characters and the text:

# a header
#not a header
```

This file was missing spaces on a bunch of headers so it didn't render correctly. This should fix it; if I missed any, it's probably easier to layer another patch on top of this one catching them rather than asking me to edit it, but whatever works!

bash-3.2$



That said, I might be mistaken.  Please advise.  Thanks!
tomaz commented 1 year ago

Indeed, looks like the right history for master branch. Puzzling because github button says "rebase and merge" instead of just "merge" 🤔 Did you perhaps base your branch off another one - develop etc!?

However I just noticed commit message - could you change that into more explanatory sentence. Smth like "Added instructions for using on M1 Macs" or similar. Just "m1" doesn't tell what the commit is about. After merging all this discussion is not visible on the repository itself, so all the context is gone. Hence I always strive to keep the messages relevant. Sorry but was puzzled to the misterious "rebase and merge" before and didn't pay attention.

Afterwards I'll hit the button and then let's see what happens...