BerkeleyLab / Marble

Dual FMC FPGA carrier board developed for general purpose use in particle accelerator electronics instrumentation.
22 stars 8 forks source link

Doc revision #27

Closed csp closed 3 years ago

csp commented 3 years ago

Update README and documentation. User manual and test guide didn't build for me at first: fixed issues to build cleanly, fixed typos, fixed tables, etc.

csp commented 3 years ago

@ldoolitt @smpaiagua Documentation needs further work, but this should be sufficient to release and send the design files out for fab for the current revision.

smpaiagua commented 3 years ago

@csp, I've pushed a few changes to the Test Guide. There's more than one link to the private marble_mmc repo. Should we remove those for now until they can be replaced by a github version?

I'd also like to add a bit more detail to the XR README.md. I'll try to do that tomorrow.

csp commented 3 years ago

@smpaiagua I would want to freeze the HW design files at least and generate the fabrication package to get quotes from vendors. After that we can continue to work on the documentation while the boards are manufactured and tag for release later. By then we should have MMC software on Github and we can update the links then.

smpaiagua commented 3 years ago

Ok, no reason not to merge this now then.