Skip to content

Commit

Permalink
docs(readme): change markdown -> reStructuresText
Browse files Browse the repository at this point in the history
Please enter the commit message for your changes. Lines starting
  • Loading branch information
adityaa30 committed Sep 25, 2020
1 parent d2ac39b commit c919aef
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 33 deletions.
31 changes: 0 additions & 31 deletions README.md

This file was deleted.

41 changes: 41 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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 <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.

.. |Commit| image:: https://github.com/adityaa30/cpcli/workflows/Check%20Commit/badge.svg
.. |Test| image:: https://github.com/adityaa30/cpcli/workflows/Test/badge.svg
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description-file = README.rst
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit c919aef

Please sign in to comment.