update links for Makefile
[slipway.git] / README
1 ______________________________________________________________________________
2 Abits+Slipway software
3
4 Quick start: type 'make asyncdemo' to run the asynchronous
5 micropipeline demo from the FCCM paper
6
7
8 ______________________________________________________________________________
9 Directory Layout
10
11 src/
12     com/
13         atmel/                   -- Fpslic classes
14         ftdi/
15              FtdiUart.java       -- Java wrapper for libftdi
16              FtdiUart.i          -- swig interface definition file for libftdi
17     edu/
18         berkeley/
19                  abits/          -- Abits library interfaces
20                  slipway/        -- classes for the Slipway board/platform
21                          mpar/   -- experimental code for Map, Place, And Route
22     org/ibex/util/               -- utility classes
23
24 doc/                             -- documentation
25     manuals/                     -- various manuals
26     pins.txt                     -- some notes on the pins used for configuration
27     gosset.txt                   -- Gosset's post to comp.arch.fpga
28     CONVENTIONS                  -- some naming conventions used
29     images/                      -- some images and diagrams
30     fccm07/                      -- Adam's FCCM'07 paper (TeX source)
31
32 build/                           -- compiled stuff winds up here
33
34 upstream/                        -- "upstream" software packages
35
36 pcb/                             -- board schematic files for the Slipway board; unfortunately
37                                     these are in a proprietary expresspcb.com file format
38
39 misc/
40      slipway.ept                 -- eeprom programming file for USB interface
41      slipway.apj                 -- Atmel project file (used for building drone bitstream)
42      slipway_drone.bst           -- prebuilt drone bitstream
43      verilog.model               -- an incomplete verilog model for emulating Atmel CLBs