From: Oleg Broytman Date: Sun, 30 Apr 2017 21:22:51 +0000 (+0300) Subject: Convert README to reST X-Git-Url: https://git.phdru.name/?p=cookiecutter.git;a=commitdiff_plain;h=832bdbfd41ce1c7954f56f1218ca1cacdec0f43a Convert README to reST --- diff --git a/mk-project b/mk-project index c23664c..3195001 100755 --- a/mk-project +++ b/mk-project @@ -14,7 +14,7 @@ cp -ap project_template "$HOME/tmp/$project_name" && cd "$HOME/tmp/$project_name" && mv project "$project_name" && -replace '{project}' "$project_name" .gitignore README.txt \ +replace '{project}' "$project_name" .gitignore README.rst \ devscripts/README.html docs/genapidocs docs/install.rst \ mk-distr publish-docs setup.py tox.ini && diff --git a/project_template/README.rst b/project_template/README.rst new file mode 100644 index 0000000..852f998 --- /dev/null +++ b/project_template/README.rst @@ -0,0 +1,17 @@ +========= +{project} +========= + +Author: Oleg Broytman . + +Copyright (C) 2017 PhiloSoft Design. + +License: GPL. + +This is {project}. + +| Home Page: http://phdru.name/Software/Python/{project}/ +| Documentation: http://phdru.name/Software/Python/{project}/docs/ +| Git repo: http://git.phdru.name/{project}.git/ +| GitHub repo: https://github.com/phdru/{project} +| Issue tracker: https://github.com/phdru/{project}/issues diff --git a/project_template/README.txt b/project_template/README.txt deleted file mode 100644 index 5cd2e80..0000000 --- a/project_template/README.txt +++ /dev/null @@ -1,11 +0,0 @@ -Broytman {project}, Copyright (C) 2017 PhiloSoft Design -Author: Oleg Broytman -License: GPL - -This is {project}. - -Home Page: http://phdru.name/Software/Python/{project}/ -Documentation: http://phdru.name/Software/Python/{project}/docs/ -Git repo: http://git.phdru.name/{project}.git/ -GitHub repo: https://github.com/phdru/{project} -Issue tracker: https://github.com/phdru/{project}/issues diff --git a/project_template/setup.py b/project_template/setup.py index b8c629f..21d21b6 100755 --- a/project_template/setup.py +++ b/project_template/setup.py @@ -18,7 +18,7 @@ from {project}_version import __version__ # noqa setup(name='{project}', version=__version__, description='Broytman {project}', - long_description=open('README.txt', 'rU').read(), + long_description=open('README.rst', 'rU').read(), author='Oleg Broytman', author_email='phd@phdru.name', url='http://phdru.name/Software/Python/{project}', diff --git a/rename-project b/rename-project index 2eff036..749ad6d 100755 --- a/rename-project +++ b/rename-project @@ -49,5 +49,5 @@ for project_dir in "$HOME"/prog/Python "$HOME"/current/projects \ fi fix_files devscripts/README.html \ docs/conf.py docs/genapidocs docs/index.rst docs/install.rst \ - README.txt mk-distr setup.py tox.ini + README.rst mk-distr setup.py tox.ini done