A simple script to generate a README.md for conan recipes.
Before using this Python script, you need to:
-
Install the script and all its dependencies. There are two ways:
a) pip install git+https://github.com/bincrafters/conan-readme-generator --upgrade or b) git clone https://github.com/bincrafters/conan-readme-generator cd conan-readme-generator pip install . --upgrade
-
Change directory into the recipe's location (i.e. where conanfile.py is)
cd conan-libname
-
Execute this script:
conan-readme-generator "bincrafters/channel"
A README.md will be generated in the conan-libname
directory.
-
Install test requirements:
pip install -r conan_readme_generator/requirements_test.txt
-
Execute all test:
nosetests .