README

   1 This contains the TinyOS 2.0 source code as of
   2
   3 $Date$
   4
   5 This tree includes the TinyOS 2.0 documentation in tinyos-2.x/doc;
   6 you can also find the documentation online at:
   7 http://www.tinyos.net/tinyos-2.x/doc/
   8
   9 Please note that RPM releases do not include the doc/ or tools/
  10 directories. They do not include the former because of the above URL,
  11 where corrections can be applied quickly. They do not include the
  12 latter because that compiled versions of its code are installed in
  13 the tinyos-tools RPM.
  14
  15 The basic directory structure is as follows:
  16
  17 apps: Sample TinyOS applications.
  18   tests: Sample TinyOS applications which test a part of the system.
  19
  20 doc: Documentation
  21   index.html: Index file to all documentation
  22   txt: Text files (TEPs)
  23   html: HTML files (TEPs, installation)
  24     tutorial: Tutorials
  25   pdf: PDFs of larger documents, such as the TinyOS Programming Manual
  26
  27 support: Non-nesC code for using TinyOS nodes
  28   make: TinyOS make system
  29   sdk: Standard developers kit: serial communication, etc.
  30     c: C SDK (fully supported, but not exhaustively tested yet)
  31     java: Java SDK (fully supported, heavily tested and used)
  32     python: Python SDK (limited, not fully supported)
  33
  34 tools: TinyOS-specific tools and scripts
  35   platforms: Platform-specific tools
  36   release: Scripts and configurations for packaging release RPMs
  37   tinyos: TinyOS scripts
  38     java: Native support for TinyOS JNI libraries (serial and env)
  39     misc: Assorted utility scripts, begininning with tos-
  40     ncc: The scripts that invoke the nesC compiler: ncc, mig, ncg
  41
  42 tos: TinyOS source code (nesC, C)
  43   chips: Chip-specific code
  44   interfaces: Core system interfaces
  45   lib: Extensions and larger common subsystems
  46     byte_radio: General radio stack for byte-level radios
  47     net: Network (multihop protocols)
  48       ctp: Collection tree protocol
  49       le: Link estimator
  50       lqi: LQI-based collection for CC2420 platforms
  51     power: Power management component library
  52     printf: Printing small text messages to serial port
  53     serial: Serial communication
  54     timer: Timer component library
  55     tossim: TOSSIM simulator
  56   platforms: Platform-specific code
  57   sensorboards: Sensorboard drivers
  58   system: Core system components
  59   types: Core system data types (header files)
  60
  61 You can find documentation for the 2.0.1 release online at:
  62 http://www.tinyos.net/tinyos-2.x/doc/
  63