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

Improve README/help regarding build types #261

Open
edubart opened this issue Aug 1, 2024 · 0 comments
Open

Improve README/help regarding build types #261

edubart opened this issue Aug 1, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edubart
Copy link
Contributor

edubart commented Aug 1, 2024

A suggestion is to add those options to the make help target. Something like:

help:
	@echo 'Main targets:'
	@echo '* all - Build the src/ and uarch/ code. To build from a clean clone, run: make submodules all'
	@echo '        Additionally, to specify the build type, pass yes to one of:'
	@echo '        - sanitize, debug, relwithdebinfo, *release*, coverage. e.g: make sanitize=yes

Another point, a bit unrelated to this PR is removing the Emscripten documentation from the README.md. A brief comment pointing to the wiki should suffice. Should we do the same for the mingw toolchain?

Originally posted by @mpolitzer in #250 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant