Improve build documentation #215
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
This is useful for people that are not running a Debian/Ubuntu system.
These docs only work for a arm32. Additionally, these were originally to cross-compile for OpenWRT, but we now have the toolchains in CMakeModules/CMakeToolchains that can be used for this.
All of the OpenWRT presets now have the version they are.
The main thing I don't like is how the OpenWRT badge looks, but 🤷 |
This was referenced Jul 29, 2022
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.
Improves the build instructions and documentation in the README.md
docs: document compiling in a docker image
This is useful for people that are not running a Debian/Ubuntu
system.
docs: remove Docker cross-compile instructions
These docs only work for a arm32, which causes a bit of confusion in Documentation missing a preset for TARGET=aarch64-linux-musl #209.
Additionally, these were originally to cross-compile for OpenWRT, but we now have the toolchains in CMakeModules/CMakeToolchains that can be used for this.
docs: document cmake --list-presets options
docs: document using CMake toolchain files
This is how people can add their own cross-compiling configurations
build: standardise CMake preset names
All of the OpenWRT presets now have the version they are. (e.g. that they use OpenWRT-19.07.10)
docs: add OpenWRT package feed link
Adds a link to https://github.com/nqminds/manysecured-openwrt-packages and recommends using that to compile edgesec.
Additionally, I added a badge that links to the feed