Skip to content

Commit

Permalink
Documentation Update:
Browse files Browse the repository at this point in the history
Updated installation instructions
Fixed syntax errors for ReadTheDocs
  • Loading branch information
amishatishpatel committed Jul 26, 2019
1 parent 1ad376c commit 0036977
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ The distribution on the Python Package Index is, of course, a built-distribution

Unfortunately the success of your installation using `pip` depends on the host OS of the installation, and you might need to rebuild the utility using the C-compiler native to your OS. In short, follow the more traditional method of installing custom Python packages.

```python
$ git clone https://github.com/ska-sa/casperfpga.git
```shell
$ git clone https://github.com/casper-astro/casperfpga.git
$ cd casperfpga
$ sudo pip install -r requirements.txt
$ sudo python setup.py install
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Unfortunately the success of your installation using ``pip`` depends on the host

.. code-block:: bash
$ git clone https://github.com/ska-sa/casperfpga.git
$ git clone https://github.com/casper-astro/casperfpga.git
$ cd casperfpga
$ sudo pip install -r requirements.txt
$ sudo python setup.py install
Expand All @@ -62,6 +62,7 @@ If you receive any errors after this please feel free to contact anyone on the `
Usage
#####
The introductory tutorials for `ROACH <https://casper.berkeley.edu/wiki/Introduction_to_Simulink>`__, `ROACH2 <https://casper.berkeley.edu/wiki/Introduction_to_Simulink_ROACH2>`__ and `SKARAB <https://casper.berkeley.edu/wiki/Introduction_to_Simulink_SKARAB>`__ serve as a guide to the entire process of:

* Creating an FPGA design in Simulink using the CASPER and Xilinx Blocksets
* Building the design using the toolflow, and lastly
* Reconfiguring your CASPER Hardware with the generated .fpg file using `casperfpga`
Expand Down

0 comments on commit 0036977

Please sign in to comment.