casper-astro / mlib_devel

http://casper-toolflow.readthedocs.io/en/latest/jasper_documentation.html
56 stars 86 forks source link

RFSoC: No recursive cloning in tutorial instructions #193

Closed jwkunz closed 1 year ago

jwkunz commented 1 year ago

I was getting a failed jasper synthesis on the vanilla zcu111_tut_onehundred_gbe file. I went digging through the generate source code and after some splunking in my file system I realized this issue was a missing kutleng_skarab2_bsp_firmware directory. Looking in the github repo, I realized this was a submodule that was not in my local filesystem.

The current tutorial instructions do not mention the recursive cloning of submodules. I recommend adding this to the instructions for new users.

In summary,

Change: "git clone https://github.com/casper-astro/mlib_devel.git" To: "git clone https://github.com/casper-astro/mlib_devel.git --recursive"

in the "Getting Started With RFSoC" page. May also add a note about this in the text.

mitchburnett commented 1 year ago

There is a section in the Getting Started With RFSoC page under Toolflow Setup for initialization of submodules.

https://casper-toolflow.readthedocs.io/projects/tutorials/en/latest/tutorials/rfsoc/tut_getting_started.html#toolflow-setup

jwkunz commented 1 year ago

Silly me. I scanned over that git submodule init command.