Add build instruction for MacOS #648
Conversation
RenfengLiu
force-pushed
the
build_instruction_macos
branch
from
1984041 to
79aefb1
Compare
RenfengLiu
force-pushed
the
build_instruction_macos
branch
from
79aefb1 to
91e8b96
Compare
|
|
||
| ### macOS | ||
|
|
||
| - Install build dependencies: `brew install cmake ninja python` |
There was a problem hiding this comment.
This is the "##Environment Variables" section, I think we have platform independent prerequisites installation stuff under "#Prerequisites". I would suggest doing a bit of restructuring:
# Prerequisites
## Dependencies
General overview here
### Windows
### Linux
move the section "On Linux, set up environment variables for building GFXReconstruct as explained..."
### macOS
your new special info here for "brew install"
## Environment Variables
### Windows
### Linux
### macOS
your new section on env vars
There was a problem hiding this comment.
Personally, if I'm developing on Linux or MacOS, I'd prefer everything related to that platform at one places and in execution order. so that I can copy paste the commands, instead of read the whole doc and find each related sections, and worry about if I missing something somewhere
There was a problem hiding this comment.
Then I think maybe:
# Prerequisites
General overview
## Windows
## Linux
## macOS
specific instructions and env vars
Personally, if I'm developing on Linux or MacOS, I'd prefer everything related to that platform at one places and in execution order. so that I can copy paste the commands, instead of read the whole doc and find each related sections, and worry about if I missing something somewhere
But I will point out that this is the current organizational structure of the BUILD.md and the README.md. The docs do not have everything related to a platform at one place: we are branching the platform-dependent stuff as the lowest level header usually. If you want to do a rearrangement that's fine but I think it should be applied consistently.
4 participants
No description provided.