Skip to content

Commit

Permalink
PyPI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianliaw committed Nov 21, 2014
1 parent 130e3fc commit bd962e7
Showing 1 changed file with 19 additions and 21 deletions.
40 changes: 19 additions & 21 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,44 @@
The cube can be revealed as expanded view in the terminal, so it’s easy
to visualise the cube, just inside the terminal.
.. code:: python
.. code-block:: python
import pycuber as pc
>>> import pycuber as pc
# Create a Cube object
mycube = pc.Cube()
>>> # Create a Cube object
>>> mycube = pc.Cube()
# Do something at the cube.
mycube("R U R' U'")
>>> # Do something at the cube.
>>> mycube("R U R' U'")
print(mycube)
>>> print(mycube)
::
.. image:: https://camo.githubusercontent.com/906f83f4933fe1d0741b7d3ff43bda66fb464cdd/68747470733a2f2f7261772e6769746875622e636f6d2f61647269616e6c6961772f507943756265722f76302e31622f7374617469632f696d672f7465726d696e616c2e706e67
We also provided some useful tools to deal with Rubik’s Cube algorithms.
.. code:: python
.. code-block:: python
import pycuber as pc
>>> import pycuber as pc
# Create an Algo object
myalg = pc.Algo("R U R' U' R' F R2 U' R' U' R U R' F'")
>>> # Create an Algo object
>>> myalg = pc.Algo("R U R' U' R' F R2 U' R' U' R U R' F'")
# Reversing an Algo
myalg.reverse()
print(myalg)
>>> # Reversing an Algo
>>> myalg.reverse()
>>> print(myalg)
# Mirroring an Algo object
myalg.mirror("LR")
print(myalg)
>>> # Mirroring an Algo object
>>> myalg.mirror("LR")
>>> print(myalg)
::
F R U' R' U R U R2 F' R U R U' R'
F' L' U L U' L' U' L2 F L' U' L' U L
I’ll add some documentations later.
"""
I’ll add some documentations later."""

setup(
name = "pycuber",
Expand Down

0 comments on commit bd962e7

Please sign in to comment.