Skip to content
This repository has been archived by the owner on Aug 18, 2018. It is now read-only.

updating readme and coveralls badge #16

Merged
merged 1 commit into from
Oct 3, 2017
Merged

updating readme and coveralls badge #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
OpenFermion-ProjectQ
====================

.. image:: https://travis-ci.org/quantumlib/OpenFermion-ProjectQ.svg?branch=develop
.. image:: https://travis-ci.org/quantumlib/OpenFermion-ProjectQ.svg?branch=master
:target: https://travis-ci.org/quantumlib/OpenFermion-ProjectQ

.. image:: https://coveralls.io/repos/github/quantumlib/OpenFermion-ProjectQ/badge.svg?branch=develop
.. image:: https://coveralls.io/repos/github/quantumlib/OpenFermion-ProjectQ/badge.svg?branch=master
:target: https://coveralls.io/github/quantumlib/OpenFermion-ProjectQ?branch=develop

.. image:: https://badge.fury.io/py/openfermionprojectq.svg
Expand All @@ -17,17 +17,17 @@ Getting started
---------------

To start using OpenFermion-ProjectQ, first install `OpenFermion <http://openfermion.org>`_ and `ProjectQ <https://projectq.ch>`_.
Then, clone this git repo, change directory to the top level folder and run:
Then, clone `this <http://github.com/quantumlib/OpenFermion-ProjectQ>`__ git repo, change directory to the top level folder and run:

.. code-block:: bash

python -m pip install -e .

Alternatively, one can install the last major release with the command
Alternatively, if using OpenFermion-ProjectQ as a library, one can install the last official PyPI release with:

.. code-block:: bash

python -m pip install openfermionprojectq
python -m pip install --pre --user openfermionprojectq

Authors
-------
Expand Down