Skip to content

Commit

Permalink
Reordered readme
Browse files Browse the repository at this point in the history
  • Loading branch information
williamjameshandley committed Nov 5, 2018
1 parent 00a5d1a commit e2b62d5
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,30 @@ markdown to jupyter notebooks.
Markdown cells are rendered from comments beginning with ``#|``, splits between
code cells are created by comment lines beginning with ``#-``

Installation
============

Users can install using pip:

.. code:: bash
pip install py2nb
from source:

.. code:: bash
git clone https://github.com/williamjameshandley/py2nb
cd py2nb
python setup.py install
or for those on `Arch linux <https://www.archlinux.org/>`__ it is
available on the
`AUR <https://aur.archlinux.org/packages/python-py2nb/>`__

Example
=======

If one has a script named ``example.py`` containing the code:

.. code:: python
Expand Down Expand Up @@ -62,29 +86,6 @@ then running
produces the notebook `example.ipynb <https://github.com/williamjameshandley/py2nb/blob/master/example.ipynb>`_

Installation
===============

Users can install using pip:

.. code:: bash
pip install py2nb
from source:

.. code:: bash
git clone https://github.com/williamjameshandley/py2nb
cd py2nb
python setup.py install
or for those on `Arch linux <https://www.archlinux.org/>`__ it is
available on the
`AUR <https://aur.archlinux.org/packages/python-py2nb/>`__



To do
=====
- reverse script
Expand Down

0 comments on commit e2b62d5

Please sign in to comment.