-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): change markdown -> reStructuresText
Please enter the commit message for your changes. Lines starting
- Loading branch information
Showing
4 changed files
with
43 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
[metadata] | ||
description-file = README.md | ||
description-file = README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters