diff --git a/README.rst b/README.rst index e69de29..14d0b90 100644 --- a/README.rst +++ b/README.rst @@ -0,0 +1,19 @@ +generate changelog +================== + +This project hosts a simple python script that tries to generate a RPM changelog +from a git repository. + +This is how you can use it: + +* Clone a dist-git repository + +:: + + fedpkg clone -a guake + +* Run ``generate_changelog`` and point it to the repository cloned above + +:: + + python generate_change guake