From 9a9e57c9eb524f876180c6f3b596f2203446c18b Mon Sep 17 00:00:00 2001 From: mueller-ma Date: Wed, 13 Dec 2017 21:00:15 +0100 Subject: [PATCH] =?UTF-8?q?Add=20$=20or=20#=20to=20indicate=20whether=20a?= =?UTF-8?q?=20command=20needs=20to=20be=20run=20as=20root=20or=20n?= =?UTF-8?q?=E2=80=A6=20(#602)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - [ci skip] --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7fe5846..fc3bbf7 100644 --- a/README.md +++ b/README.md @@ -43,20 +43,20 @@ release (or version) of the project." ## Installation - gem install github_changelog_generator + $ [sudo] gem install github_changelog_generator See also Troubleshooting. ## 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 - 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: - github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 + $ github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 - In general, it looks like this: @@ -83,19 +83,25 @@ See also Troubleshooting. - Run this: - `github_changelog_generator -u github_username -p github_project` - `github_changelog_generator github_username/github_project` + $ github_changelog_generator -u github_username -p 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: - github_changelog_generator --github-site="https://github.yoursite.com" \ - --github-api="https://github.yoursite.com/api/v3/" + $ github_changelog_generator --github-site="https://github.yoursite.com" \ + --github-api="https://github.yoursite.com/api/v3/" This generates a `CHANGELOG.md`, with pretty Markdown formatting. ### 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)