diff --git a/platform/esb/doc/esb.txt b/platform/esb/doc/esb.txt index d1715303e..3f13c03d5 100644 --- a/platform/esb/doc/esb.txt +++ b/platform/esb/doc/esb.txt @@ -29,17 +29,10 @@ Windows users, see \ref esb-win-setup. FreeBSD users, see \ref esb-freebsd-setup \section esb-win-setup Setting up the Windows environment -This is a brief introduction to Contik/ESB programming under Windows -using cygwin and some other free software tools. - -\subsection winintro-installing Installing the development environment - -\subsubsection winintro-installing-cygwin Installing Cygwin - -The first "need to have" software is the cygwin environment that can -be found at http://www.cygwin.com. Cygwin is a Linux-like environment -for Windows. Click on the icon "Install Cygwin Now" to the right to -get the installation started. +The Contiki development environment under Windows uses the Cygwin +environment. Cygwin is a Linux-like environment for Windows. Cygwin +can be found at http://www.cygwin.com. Click on the icon "Install +Cygwin Now" to the right to get the installation started. Choose "Install from Internet" and then specify where you want to install cygwin (recommended installation path: @@ -57,7 +50,7 @@ When cygwin is installed there should be a cygwin icon that starts up a cygwin bash when clicked on. Whenever it is time to compile and send programs to the ESB nodes it will be done from a cygwin shell. -\subsubsection winintro-installing-editor C programming editor +\subsection winintro-installing-editor C programming editor If you do not already have a nice programming editor it is a good idea to download and install one. The Crimson editor is a nice @@ -70,7 +63,7 @@ http://www.crimsoneditor.com/ The editor is useful both when editing C programs and when modifying scripts and configuration files. -\subsubsection winintro-installing-compiler MSP430 Compiler and tools +\subsection winintro-installing-compiler MSP430 Compiler and tools A compiler is needed to compile the programs to the MSP430 microprocessor that is used on the ESB sensor nodes. Download and @@ -96,7 +89,7 @@ home directory If your home directory is located elsewhere you can find it by starting cygwin and running \c cd followed by \c pwd. -\subsubsection winintro-installing-contiki The Contiki operating system, including examples +\subsection winintro-installing-contiki The Contiki operating system, including examples When programming the ESB sensor nodes it is very useful to have an operating system that takes care of some of the low-level tasks and @@ -129,7 +122,7 @@ need to delete cygwin1.dll from the MSP430 GCC toolchain Connect a node and turn it on. Upload the test application by calling make beeper.u. -\subsubsection winintro-testing-development Development tools +\subsection winintro-testing-development Development tools - make \ will compile and make a executable file ready for sending to the ESB nodes. Depending on the \c SPEC it might even @@ -138,7 +131,7 @@ node. Typically you would write things like "make beeper.u" to get the file beeper.c compiled, linked and sent out to the ESB node -\subsubsection winintro-testing-shell Some basic shell commands +\subsection winintro-testing-shell Some basic shell commands - cd \ change to a specified directory (same as in DOS) - pwd \ shows your current directory diff --git a/platform/esb/doc/getting-started.txt b/platform/esb/doc/getting-started.txt index 83eaa2f2a..eb6a4318e 100644 --- a/platform/esb/doc/getting-started.txt +++ b/platform/esb/doc/getting-started.txt @@ -1,28 +1,18 @@ /** -\addtogroup doc +\addtogroup esb +\section esb-getting-started Getting started with Contiki for the ESB platform + +The ESB is equipped with an MSP430 microcontroller. The first step to +getting started with Contiki for the ESB is to install the development +tools for compiling Contiki for the MSP430. + +For Windows users, see \ref esb-winintro + + @{ */ + /** - -\defgroup getting-started Getting started with Contiki -@{ - -\section getting-started-intro Introduction - -What is Contiki? - -What is its relation to the ESB? - -How are programs written for it? - -\section getting-started-example An example program - blinker - -\subsection getting-started-compiling Compiling blinker - -\subsection getting-started-running Running blinker - -\subsection getting-started-simulation Running blinker in the simulator - - -*/ \ No newline at end of file +@} +*/