Merge pull request #78 from kreczko/kreczko/changelog-generator-doc

Clarifications on how to use changelog generator

Makefile

@@ -51,7 +51,7 @@ data/L1Ntuple_test_3.root:
 pep8:
 	@pep8 --exclude=.git,external examples cmsl1t
 
-flake8: 
+flake8:
 	@flake8 $(shell file -p bin/* |awk -F: '/python.*text/{print $$1}') cmsl1t test --ignore=F401 --max-line-length=120
 
 # benchmarks
@@ -81,6 +81,8 @@ test-code-full:
 	@$(NOSETESTS) -v -s test
 
 changelog:
+	@echo "If you have not done it, please run"
+	@echo "export CHANGELOG_GITHUB_TOKEN=<from https://github.com/settings/tokens>"
 	@github_changelog_generator -u cms-l1t-offline -p cms-l1t-analysis --base docs/initial_changelog.md
 
 docs-html:

README.md

@@ -57,7 +57,11 @@ make benchmark
 ```
 
 ### Generating changelog
+Since the changelog generator queries the repository you will need to give it
+a github authentication token to bypass the limits for unauthenticated access.
+You can create such tokens under https://github.com/settings/tokens .
 ```bash
+export CHANGELOG_GITHUB_TOKEN=<from https://github.com/settings/tokens>
 make changelog
 ```