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

Commit

Permalink
removed improper link to docs (#22)
Browse files Browse the repository at this point in the history
* removed improper link to docs

* fixed typo

* realized that we can automatically install openfermion and projectq
  • Loading branch information
babbush authored and jarrodmcc committed Oct 6, 2017
1 parent 8c3e8e9 commit 1446f49
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ This plugin library allows the circuit simulation and compilation package `Proje
Getting started
---------------

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

.. code-block:: bash
Expand All @@ -33,7 +33,7 @@ How to contribute
-----------------

We'd love to accept your contributions and patches to OpenFermion-ProjectQ.
There are a few small guidelines you need to follow.
There are a few guidelines you need to follow.
Contributions to OpenFermion-ProjectQ must be accompanied by a Contributor License Agreement.
You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as part of the project.
Expand All @@ -50,8 +50,7 @@ decrease overall test coverage by too much. Make sure you adhere to our style
guide. Just have a look at our code for clues. We mostly follow
`PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ and use
the corresponding `linter <https://pypi.python.org/pypi/pep8>`_ to check for it.
Code should always come with documentation, which is generated automatically and can be found
`here <http://openfermion.readthedocs.io/en/latest/openfermion.html>`_.
Code should always come with documentation.

Authors
-------
Expand Down

0 comments on commit 1446f49

Please sign in to comment.