will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add $ or # to indicate whether a command needs to be run as root or n… (#602)

Browse Source 
- [ci skip]
This commit is contained in:
mueller-ma 2017-12-13 21:00:15 +01:00 committed by Olle Jonsson
parent ff6a9c0ff3
commit 9a9e57c9eb
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -43,20 +43,20 @@ release (or version) of the project."
## Installation ## Installation
gem install github_changelog_generator $ [sudo] gem install github_changelog_generator
See also Troubleshooting. See also Troubleshooting.
## Running with Docker ## Running with Docker
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app skywinder/github-changelog-generator $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app skywinder/github-changelog-generator
## Output example ## Output example
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project - Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command: - [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 $ github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
- In general, it looks like this: - In general, it looks like this:
@ -83,19 +83,25 @@ See also Troubleshooting.
- Run this: - Run this:
`github_changelog_generator -u github_username -p github_project` $ github_changelog_generator -u github_username -p github_project
`github_changelog_generator github_username/github_project`
or, on the 1.14.x (current stable release)
$ github_changelog_generator github_username/github_project
- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options: - For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
github_changelog_generator --github-site="https://github.yoursite.com" \ $ github_changelog_generator --github-site="https://github.yoursite.com" \
--github-api="https://github.yoursite.com/api/v3/" --github-api="https://github.yoursite.com/api/v3/"
This generates a `CHANGELOG.md`, with pretty Markdown formatting. This generates a `CHANGELOG.md`, with pretty Markdown formatting.
### Params ### Params
Type `github_changelog_generator --help` for details. Print help for all command-line options to learn more details:
$ github_changelog_generator --help
For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples) For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)