Skip to content

Commit 73d2848

Browse files
committed
Update Readme with Voila and Update Gitignore
1 parent 1436145 commit 73d2848

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

.gitignore

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
1-
*\rfsoc_pynq
2-
.Xil
3-
vivado.jou
4-
vivado.log
5-
*.log
1+
# Ignore Other
62
*.htm
73
.ipynb_checkpoints
84
.idea
5+
6+
# Ignore Logs
7+
*.log
8+
9+
# Ignore Simulink Files
10+
*.autosave
911
*.slxc
12+
*\.hbs
13+
*\.Xil
14+
*\hdl_prj
1015
*\slprj
1116
*\wavedata
12-
*.autosave
17+
18+
# Ignore Vivado Files
19+
*.jou
20+
*vivado.txt
21+
*vivado.jou
22+
*vivado.log
23+
24+
# Ignore ./rfstrath/rfstrath/
25+
**/rfsoc_qpsk/rfstrath
26+
**/rfsoc_qpsk/rfsoc_pynq
27+
**/rfsoc_qpsk/rfsoc_qpsk

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ pip3 install git+https://github.com/strath-sdr/rfsoc_qpsk
3737

3838
Once installation has complete, you will find the QPSK demonstrator notebooks located in the jupyter home workspace in the `qpsk-demonstrator` folder.
3939

40+
This repository uses Voila to create simple web applications using Jupyter notebooks. Your RFSoC2x2 development board should already be preinstalled with a version of Voila and no further setup is required.
41+
4042
## ZCU111 Setup
4143
The ZCU111 PYNQ image already comes preinstalled with the QPSK demonstrator package. To use this repository correctly you should force reinstall the rfsoc-qpsk package by executing the following command in the terminal:
4244

@@ -46,6 +48,8 @@ pip3 install --force-reinstall --no-deps git+https://github.com/strath-sdr/rfsoc
4648

4749
Once installation has complete, you will find the QPSK demonstrator notebooks located in the jupyter home workspace in the `qpsk-demonstrator` folder.
4850

51+
This repository uses Voila to create simple web applications using Jupyter notebooks. If you would like to use Voila on your ZCU111 development board, simply follow the instructions outlined in this [blog post](https://strath-sdr.github.io/pynq/linux/zynq/fpga/voila/2021/02/22/install-voila-on-pynq-v2-6.html).
52+
4953
## Using the Project Files
5054
The following software is required to use the project files in this repository.
5155
- Vivado Design Suite 2020.1

0 commit comments

Comments
 (0)