Changes between Initial Version and Version 1 of Installation Notes

Timestamp:

Mar 27, 2007, 5:39:07 PM (17 years ago)

Author:

Nicolas Pouillon

Comment:

--

Installation Notes

@@ +1 @@
+= Installation Notes =
+
+== Prepare the environment ==
+
+You'll need:
+ * A C++ compiler, preferably g++
+ * A working SystemC implementation
+   * [http://www.systemc.org/ OSCI implementation]
+   * SystemCass
+ * Binutils and BFD for your target CPU
+ * A [http://subversion.tigris.org/ Subversion] client
+ * A recent [http://www.python.org/ Python] interpreter
+ * A bourne-shell compatible, like bash
+ * [http://www.libsdl.org/ SDL] (for graphic utilities)
+
+== Getting SoCLib ==
+
+{{{
+$ cd where/to/put/soclib
+$ svn co https://www.soclib.fr/svn/trunk/soclib soclib
+}}}
+
+Put `soclib/bin` in your `$PATH`, preferably add this line in your shell's startup scripts.
+
+{{{
+$ export PATH=$PATH:where/to/put/soclib/bin
+}}}
+
+== Compiling tools ==
+
+Some tools need compilation before use:
+{{{
+$ cd where/to/put/soclib/utils/src
+$ make
+$ make install
+}}}
+
+== Configuration ==
+
+You may edit [SoclibConf SoCLib's configuration file]. Out of the box, the only thing the configuration
+needs is setting an environment variable pointing to your SystemC implementation. Again
+this may preferably reside in your shell's startup scripts:
+{{{
+$ export SYSTEMC=/path/to/systemc
+}}}
+
+If you want to check, you should have a listing close to this one:
+{{{
+$ ls $SYSTEMC
+AUTHORS  ChangeLog  LICENSE  README        docs      include
+COPYING  INSTALL    NEWS     RELEASENOTES  examples  lib-linux
+}}}
+
+== Other paths ==
+
+You should have cross-compilers in you path as well.
+For instance you should have a generic mipsel compiler toolsuite available as
+`mipsel-unknown-elf-*`.
+
+If they are not in the `$PATH`, add them in:
+{{{
+$ export PATH=$PATH:/path/to/compiler/suite/bin
+}}}
+
+== Testing ==
+
+Let's compile a simple platform:
+{{{
+$ cd /path/to/soclib/platforms/timer_4mips
+$ make
+[...]
+$ ./system.x
+}}}
+
+If ever this fails, see if [SoclibConf SoCLib's configuration file] may help you.