From aaab0abecaa92f384c8a6cfbbf7b7cc67e8042a3 Mon Sep 17 00:00:00 2001 From: Kolja Waschk Date: Sun, 25 Nov 2007 14:45:11 +0000 Subject: [PATCH] Layout draft for new, comprehensive documentation... git-svn-id: https://urjtag.svn.sourceforge.net/svnroot/urjtag/trunk@786 b68d4a1b-bc3d-0410-92ed-d4ac073336b7 --- jtag/doc/doc-layout.txt | 85 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 jtag/doc/doc-layout.txt diff --git a/jtag/doc/doc-layout.txt b/jtag/doc/doc-layout.txt new file mode 100644 index 00000000..b3a8bc10 --- /dev/null +++ b/jtag/doc/doc-layout.txt @@ -0,0 +1,85 @@ += UrJTAG = + + = Copyright / Licensing + = Authors, contributors, ... thanks = + +== General == + + = Name + = About JTAG in general + = Installation + = from binary tarball + = from source tarball + = from svn + = Cygwin/MinGW specifics + = Getting updates + = Further info / support + +== Usage == + + = Quick start: flash example + = Configuration, cable setup + = Chain setup + = Part setup + = Doing things with parts + = Pin I/O + = Memory I/O + = FPGA configuration + = Flash programming + = ... + + = SVF Player + + = bsdl2jtag, data files + + = target specific documentation = + = EJTAG support + = Blackfin support (when available) + +== Internals == + + = How to + .. add a part + .. add a command + .. add a bus driver + .. add a cable driver + ,, + .. create a patch and upload to SF + + = Directory structure + data/ + ./include/ + ../include/ + libbrux/ + cmd/ flash/ + src/ + bus/ cmd/ lib/ tap/ svf/ + + = Cable driver interface + parport + cable + chain + + = Bus driver interface + + ... + + = target specific internals = + +== Frequently asked questions == + + = Cygwin/MinGW + = Compilation problems + +== Future plans == + + = API and library package + = Bindings for Python, Perl, ... + = TCP/IP access + = New cable drivers + = ... + += Revision information / Changelog = + += License(s) texts = +