Update documentation. (#280)
authorAntony Vennard <diagprov@users.noreply.github.com>
Wed, 5 May 2021 00:15:26 +0000 (02:15 +0200)
committerGitHub <noreply@github.com>
Wed, 5 May 2021 00:15:26 +0000 (10:15 +1000)
Update documentation to reference fusesoc init for Xilinx boards, for
those like me who have never used fusesoc before. Add a reference to the
board files for Digilent boards and comment on perhaps installing them
for other boards as appropriate.

Signed-off-by: Antony Vennard <antony@vennard.ch>
README.md

index e11e56f3ecf4b48e211638448cd4578ba3fb5e8c..a1920c3869757311d526935acb9f04f2d52585fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -97,6 +97,14 @@ sudo dnf copr enable sharkcz/danny
 sudo dnf install fusesoc
 ```
 
+- If this is your first time using fusesoc, initialize fusesoc. 
+  This is needed to be able to pull down fussoc library components referenced 
+  by microwatt. Run
+
+```
+fusesoc init
+```
+
 - Create a working directory and point FuseSoC at microwatt:
 
 ```
@@ -106,6 +114,8 @@ fusesoc library add microwatt /path/to/microwatt/
 ```
 
 - Build using FuseSoC. For hello world (Replace nexys_video with your FPGA board such as --target=arty_a7-100):
+  You may wish to ensure you have [installed Digilent Board files](https://reference.digilentinc.com/vivado/installing-vivado/start#installing_digilent_board_files) 
+  or appropriate files for your board first.
 
 ```
 fusesoc run --target=nexys_video microwatt --memory_size=16384 --ram_init_file=/path/to/microwatt/fpga/hello_world.hex