Update README #3
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
…as. We will almost certainly have to update this more before release to fix other issues, but this fixes all currently known issues. We should probably also add more detail on how to get started.
|
This change has a lot of issues that are hard to comment on here. What's the best way to handle this? One option is to use CodeFlow. The other is to sit together and go over the file line by line. My goal here is that I'd like the file to be 100% correct and there are other things that need fixing. |
|
I don't really know how to launch codeflow and do a review, so let me try to figure that out and send you a codeflow review. I'll need to get that sorted out anyway so now's a good a time as any. |
|
See codeflow for additional comments. |
MikeHopcroft
pushed a commit
that referenced
this pull request
Apr 29, 2016
Update README to fix known issues and add workarounds for known gotchas. We will almost certainly have to update this more before release to fix other issues, but this fixes all currently known issues. We should probably also add more detail on how to get started.
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.
Fix known bugs in the README.
Also, remove pandoc from the dependencies because, as far as I can tell, you can build fine without pandoc. If that's not true, we should not only add that back in but also add instructions on generating whatever it is that's generated with pandoc because I don't have pandoc and the build seems to work for me.
Note that this requires both #1 and #2 to be correct.