GitHub Landing Page updates #880
Merged
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
Hoikas
reviewed
Mar 19, 2021
Comment on lines
+133
to
+145
| <dl class="wider"> | ||
| <dt>32-bit Debug:</dt> | ||
| <dd><tt>out\install\x86-Debug\client</tt></dd> | ||
|
|
||
| <dt>32-bit Release:</dt> | ||
| <dd><tt>out\install\x86-Release\client</tt></dd> | ||
|
|
||
| <dt>64-bit Debug:</dt> | ||
| <dd><tt>out\install\x64-Debug\client</tt></dd> | ||
|
|
||
| <dt>64-bit Release:</dt> | ||
| <dd><tt>out\install\x64-Release\client</tt></dd> | ||
| </dl> |
There was a problem hiding this comment.
I think this section needs more detail. When I initially saw it, my reaction was: "wait, what are we talking about?" There's no mention of arch or build types before now by default.
There was a problem hiding this comment.
I don't know how to tell people where to find the files when the output folder varies, without also mentioning the fact that it varies 😛
| </li> | ||
|
|
||
| <li> | ||
| <p>Compile the project by using <strong>Build > Install Plasma</strong>. All required dependencies will automatically be downloaded from vcpkg as part of the build process.</p> |
There was a problem hiding this comment.
Is that what we want the default to be? Can we change the default by attempting to set a default CMAKE_BUILD_TYPE?
Co-authored-by: Adam Johnson <AdamJohnso@gmail.com>
zrax
reviewed
Mar 19, 2021
Co-authored-by: Michael Hansen <zrax0111@gmail.com>
Deledrius
approved these changes
Mar 21, 2021
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.
Preview: https://dpogue.github.io/Plasma
Expands the GitHub landing page for the project to include information about downloading builds from CI runs, how to compile Plasma with the newer vcpkg build system, how to run Plasma builds locally, and how to get involved.
This is intended to be the canonical instruction guide for building and running Plasma, rather than having poorly maintained information scattered across GitHub readme files, GoW and OpenUru wikis, and IRC logs.