From 1446f493906791a968187ea41b6d8b0dc5d6f451 Mon Sep 17 00:00:00 2001 From: Ryan Babbush Date: Fri, 6 Oct 2017 13:42:37 -0700 Subject: [PATCH] removed improper link to docs (#22) * removed improper link to docs * fixed typo * realized that we can automatically install openfermion and projectq --- README.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index b27ab85..3237c88 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ and `ProjectQ `_. -Then, clone `this `__ 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 `__ git repo, change directory to the top level folder and run: .. code-block:: bash @@ -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. @@ -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 `_ and use the corresponding `linter `_ to check for it. -Code should always come with documentation, which is generated automatically and can be found -`here `_. +Code should always come with documentation. Authors -------