Convert README to reST
authorOleg Broytman <phd@phdru.name>
Sun, 30 Apr 2017 21:22:51 +0000 (00:22 +0300)
committerOleg Broytman <phd@phdru.name>
Sun, 30 Apr 2017 21:33:50 +0000 (00:33 +0300)
mk-project
project_template/README.rst [new file with mode: 0644]
project_template/README.txt [deleted file]
project_template/setup.py
rename-project

index c23664c..3195001 100755 (executable)
@@ -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 (file)
index 0000000..852f998
--- /dev/null
@@ -0,0 +1,17 @@
+=========
+{project}
+=========
+
+Author: Oleg Broytman <phd@phdru.name>.
+
+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 (file)
index 5cd2e80..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-Broytman {project}, Copyright (C) 2017 PhiloSoft Design
-Author: Oleg Broytman <phd@phdru.name>
-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
index b8c629f..21d21b6 100755 (executable)
@@ -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}',
index 2eff036..749ad6d 100755 (executable)
@@ -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