Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build/Maintainer Docs #319

Merged
merged 15 commits into from
Sep 19, 2021
Merged

Build/Maintainer Docs #319

merged 15 commits into from
Sep 19, 2021

Conversation

StarWitch
Copy link
Member

@StarWitch StarWitch commented Aug 17, 2021

Split off from #311.

Good to go!

Copy link
Collaborator

@laochailan laochailan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Really nice to have this kind of documentation. Especially the MacOS/Windows stuff sounds like many nights of pain to get right without a manual.

I managed to spot some inaccuracies in the meson option descriptions.

doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/README.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Show resolved Hide resolved
@StarWitch StarWitch requested a review from laochailan August 18, 2021 19:23
Copy link
Member

@Akaricchi Akaricchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, took my sweet time with this again. There is a lot to cover, didn't touch the packaging and emscripten sections for now.

doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
@StarWitch StarWitch requested a review from Akaricchi August 21, 2021 04:06
@StarWitch
Copy link
Member Author

StarWitch commented Aug 21, 2021

All review comments fixed! Let me know how it looks, or when you get a chance to look at the build instructions.

Copy link
Collaborator

@laochailan laochailan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation of the meson options looks good now!

README.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
@StarWitch
Copy link
Member Author

Done! And I split off Packaging stuff into its own file, as-of-yet uncommitted. I still think it's useful to document it for posterity, especially around Emscripten, etc.

doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
doc/BUILD.rst Outdated Show resolved Hide resolved
@StarWitch StarWitch merged commit af0aef0 into new-docs Sep 19, 2021
@StarWitch StarWitch deleted the build-docs branch September 19, 2021 16:05
Akaricchi pushed a commit that referenced this pull request Nov 11, 2021
* stashing changes for build/maintainer docs

* more stashing

* fix header names

* add more TODO sections, cleanup

* PR additions

* move section up readme in doc

* more sections and clarification

* add build instructions for macOS/emscripten/Linux

* move certain sections, expand emscripten

* PR review

* PR changes, splitting off packaging into other README

* add missing line

* change ASan explanation

* PR changes

* move openssl to optional
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants