This repository has been archived by the owner on Nov 18, 2021. It is now read-only.
Documentation updates #31
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
Owner
clburlison
commented
Jan 16, 2018
- Add Code of Conduct
- Add Contributing
- Update readme with better setup instructions
clburlison
commented
Jan 16, 2018
.github/CONTRIBUTING.md
Outdated
| * `make test` | ||
|
|
||
|
|
||
| \* *This file was based off work from [Ryan L McIntyre][contributing_ref] |
There was a problem hiding this comment.
Make this italicized and remove the leading \*
.github/CODE_OF_CONDUCT.md
Outdated
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [github at clburlison.com][email]. All |
There was a problem hiding this comment.
This renders the email incorrectly. Try <github@clburlison.com>
| # Contributing Guide | ||
|
|
||
| **Working on your first Pull Request?** You can learn how from this *free* | ||
| series [How to Contribute to an Open Source Project on GitHub][First PR] |
There was a problem hiding this comment.
This renders less than ideal on GH. Make this line not as long.
README.md
Outdated
| [**Basic Usage**](#basic-usage) | ||
| [**Developers**](#developers) | ||
| [**Changelog**](#changelog) | ||
| [**License**](#license) |
There was a problem hiding this comment.
Add two spaces after each item so we have line breaks in our TOC.
README.md
Outdated
| 1. Clone this repo | ||
| ```bash | ||
| export GOPATH=$(go env GOPATH) | ||
| PATH=$PATH:${GOPATH}/bin |
There was a problem hiding this comment.
These should GOPATH & PATH should be their own bullet point.
| ```bash | ||
| make build-all | ||
| ``` | ||
| 1. Copy the correct output file from build/ to a machine and run it. |
There was a problem hiding this comment.
Add one more item on running the binary. sudo /path/bakeit, or on Windows double click.
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.