Skip to content

Commit

Permalink
Updated README with stable/latest branch
Browse files Browse the repository at this point in the history
  • Loading branch information
Derek Bolt🐾 authored and dbolt committed Dec 17, 2019
1 parent 63767fc commit 32e95a8
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Amazon Braket Python IR is an open source library that contains all the intermed

### Prerequisites
- Python 3.7+

### Steps
```bash
git clone https://github.com/aws/braket-python-ir.git
git clone https://github.com/aws/braket-python-ir.git --branch stable/latest
pip install -e braket-python-ir
```

Expand Down Expand Up @@ -73,7 +74,13 @@ instructions=[H(target=0, type=<Type.h: 'h'>), CNot(control=0, target=1, type=<T
```

## Documentation
TODO

First `cd` into the `doc` directory and run:
```bash
make html
```

Then open `BRAKET_IR_ROOT/build/documentation/html/index.html` in a browser to view the docs.

## Testing

Expand All @@ -92,14 +99,6 @@ To run an individual test:
tox -- -k 'your_test'
```

## Building Sphinx docs
`cd` into the `doc` directory and run:
```bash
make html
```

You can edit the templates for any of the pages in the docs by editing the .rst files in the `doc` directory and then running `make html` again.

## License

This project is licensed under the Apache-2.0 License.

0 comments on commit 32e95a8

Please sign in to comment.