This repository has been archived by the owner on Jul 6, 2019. It is now read-only.
Documentation Updates and Fixes #351
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
M-x fill-region Signed-off-by: Paul Osborne <[email protected]>
A user new to zinc should be able to check out the code and build the examples without having to get too lucky and/or read more of the code than they would have liked. Signed-off-by: Paul Osborne <[email protected]>
Although it is a little tedious for in-tree builds, we are now able to reasonably tell users to use cargo with a few extra arguments for builds. End user projects are likely to still require a simple Makefile in order to generate final artifacts. The configure script and generated Makefile are broken right now. Signed-off-by: Paul Osborne <[email protected]>
Checking in this config fragment is mentioned as being something that could be acceptable in the cargo documentation. This prevents non-gcc linkers for builds of the Zinc examples. I think this is likely an acceptable tradeoff, at least in the short term. Signed-off-by: Paul Osborne <[email protected]>
|
Nice to see autoconf to be gone again 😄 |
farcaller
added a commit
that referenced
this pull request
Dec 14, 2015
Documentation updates and fixes
This was referenced Dec 14, 2015
👍 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
These changes update the main README to include instructions that should actually help new (or forgetful) users to build the Zinc examples. I also removed the autotools stuff that was referenced previously in favor of encouraging users to just use Cargo.
An external reference project is also pointed to that provides next steps for an individual looking to create something for a supported process outside of Zinc itself. That project includes a simple reference Makefile that can be adapated as users see fit.