From c919aef47c7d6a95ed5a45c919c54b3c2f9f4bf9 Mon Sep 17 00:00:00 2001 From: Aditya Kumar Date: Fri, 25 Sep 2020 16:00:59 +0530 Subject: [PATCH] docs(readme): change markdown -> reStructuresText Please enter the commit message for your changes. Lines starting --- README.md | 31 ------------------------------- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- setup.py | 2 +- 4 files changed, 43 insertions(+), 33 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index b20c5fc..0000000 --- a/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Competitive Programming CLI - -![Commit](https://github.com/adityaa30/cpcli/workflows/Check%20Commit/badge.svg) -![Test](https://github.com/adityaa30/cpcli/workflows/Test/badge.svg) - -### Download Guide - -```bash -# Clone the repository -git clone https://github.com/adityaa30/cpcli - -# Change directory to the cloned directory -cd cpcli - -# Install i -pip install -e . -``` - -### Requirements - -- Python 3.6+ -- [lxml](https://pypi.org/project/lxml/) -- [zope.interface](https://pypi.org/project/zope.interface/) - -## Documentation - -Documentation is available online at the [**Github Wiki**](https://github.com/adityaa30/cpcli/wiki/Commands) - -## Contributing - -See [**Developer's Guide**](https://github.com/adityaa30/cpcli/wiki/Developer%27s-Guide) in the Wiki. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6402e7f --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +Competitive Programming CLI +=========================== + +|Commit| |Test| + +Download Guide +~~~~~~~~~~~~~~ + +.. code:: bash + + # Clone the repository + git clone https://github.com/adityaa30/cpcli + + # Change directory to the cloned directory + cd cpcli + + # Install i + pip install -e . + +Requirements +~~~~~~~~~~~~ + +- Python 3.6+ +- `lxml `__ +- `zope.interface `__ + +Documentation +------------- + +Documentation is available online at the `Github +Wiki `__ + +Contributing +------------ + +See `Developer's +Guide `__ +in the Wiki. + +.. |Commit| image:: https://github.com/adityaa30/cpcli/workflows/Check%20Commit/badge.svg +.. |Test| image:: https://github.com/adityaa30/cpcli/workflows/Test/badge.svg diff --git a/setup.cfg b/setup.cfg index 224a779..11e9ec4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,2 @@ [metadata] -description-file = README.md \ No newline at end of file +description-file = README.rst \ No newline at end of file diff --git a/setup.py b/setup.py index e3aaf9a..068ca29 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ description='Competitive Programming CLI', author='Aditya Kumar', author_email='k.aditya00@gmail.com', - long_description=open('README.md', 'r', encoding='utf-8').read(), + long_description=open('README.rst', 'r', encoding='utf-8').read(), package_dir={'': 'src'}, entry_points={'console_scripts': ['cpcli=cpcli.cmdline:execute']}, python_requires='>=3.6',