[Open Crypto Project] #38: Documentation - Developers Guide

[Open Crypto Project]

#38: Documentation - Developers Guide
----------------------+-----------------------------------------
 Reporter:  pselkirk  |       Owner:  pselkirk
     Type:  task      |      Status:  new
 Priority:  major     |   Milestone:  Novena Alpha - DNSsec Only
Component:  doc       |     Version:
 Keywords:            |  Blocked By:
 Blocking:            |
----------------------+-----------------------------------------
 This is the deep-dive into the architecture and API, aimed at developers
 who want to write new FPGA cores and/or software applications for
 Cryptech.

 * FPGA architecture
   - wrapper/software register interface
   - native/"core" interface to other cores
 * how to build the FPGA bitstream
   - getting the Xilinx toolset
   - core_selector configuration
   - Makefile/ISE builds
 * how to develop new software
   - general API guide
   - per-core API guide
 * appendix: maintainer's guide (could be a separate document)
   - how to build distribution packages

 The deliverables should be
 - a new wiki page, linked from the front page
 - a text document in the doc/ hierarchy
 (Yes, they will have to be kept in sync.)

 Ideally, the API information would come from Doxygen comments in the
 source, but we don't have that yet.

--
Ticket URL: <https://trac.cryptech.is/ticket/38>
Open Crypto Project <https://wiki.cryptech.is/>