Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Siddharths8212376 committed Sep 9, 2019
1 parent c480dad commit c906b6d
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions README.rst
Expand Up @@ -26,7 +26,44 @@ implemented using opengl-python.
Features
--------

* TODO
* The given repository contains ready to use implementation of major computer graphics algorithms for easier workflow and better productivity.

Installation
------------
With Python Package Manager ``pip``:

.. code-block:: python
pip install -i https://test.pypi.org/simple/ cg-algorithms
Basic Usage:
------------

.. code-block:: python
import cg_algorithms
For importing the circle algorithms:
------------------------------------


.. code-block:: python
from cg_algorithms import circle_algorithms
Creating a circle object:
-------------------------

.. code-block:: python
new_circle = circle_algorithms(<radius>, <x_centre>, <y_centre>)
Calling the function to draw the circle using Bresenham's algorithm:
--------------------------------------------------------------------

.. code-block:: python
new_circle.bresenham_circle()
Credits
-------
Expand All @@ -36,4 +73,10 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

View Me at: https://test.pypi.org/project/cg-algorithms/0.1.5/
Sources:
--------
View My Project at: https://test.pypi.org/project/cg-algorithms/0.1.5/

Thanks:
-------
Thanking all the contributors for their contributions.

0 comments on commit c906b6d

Please sign in to comment.