Merge pull request #2 from gijsbers/master

knz · knz · commit 07be4e869e79 · 2013-04-16T08:42:22.000-07:00
fix, extend, improve and update website to current situation
(Many thanks, bert)
diff --git a/README b/README
@@ -1,4 +1,19 @@
 WWW repos for snetdev
 ------------------------
 
-TBD
+This repository contains the content + markup for the S-Net
+repository website on Github. The content is written in Markdown.
+
+In order to view this repository on a locally running webserver
+you need to install Jekyll. Jekyll will convert the Markdown files
+to HTML. Jekyll can be installed either from http://jekyllrb.com/
+or from the usual Linux software package installation resources.
+The latter option requires the packages "ruby" and "ruby-devel"
+to be installed first.  Then continue with "gem install jekyll".
+
+When Jekyll is installed it can be run in the toplevel 
+directory of this repository with "jekyll1.9 --server --auto".
+This will give you a webserver for this repository
+on some TCP port number which is printed on stdout.
+For more help see https://github.com/mojombo/jekyll/wiki/Usage
+
diff --git a/content/howtobuild.markdown b/content/howtobuild.markdown
@@ -3,52 +3,90 @@ layout: pages
 title: Setting up and compiling
 ---
 
-1. Install libpcl - GNU Portable Coroutine Library, currently v1.12
-   available at
+1. First define some handy environment variables for your
+   preferred installation directory prefixes:
 
-   [http://www.xmailserver.org/libpcl.html](http://www.xmailserver.org/libpcl.html)
+    `export PCL_PREFIX=/your/PCL/prefix`  
+    `export LPEL_PREFIX=/your/LPEL/prefix`  
+    `export SNET_PREFIX=/your/SNET/prefix`  
 
+   They may very well have the same prefix destinations
+   such as "`/usr/local`". In the remainder of this page we will
+   use these variables to install the PCL, LPEL and S-Net software to.
 
-2. Extract the LPEL archive, then run:
 
+2. Install
+   [libPCL](http://www.xmailserver.org/libpcl.html)
+   - the GNU Portable Coroutine Library, currently
+   [version 1.12](http://www.xmailserver.org/pcl-1.12.tar.gz)
 
-    `./configure --with-pcl=<pcl_install_dir>`  
-    `--with-mctx=pcl`  
-    `--prefix=<lpel_install_dir>`    
+    `tar zxvf pcl-1.12.tar.gz`  
+    `cd pcl-1.12`  
+    `./configure --prefix=$PCL_PREFIX`  
+    `make`  
+    `make check`  
+    `make install`  
+    `cd ..`  
+
+
+3. In case the PCL libraries have been installed into
+   `$PCL_PREFIX/lib64` move them to `$PCL_PREFIX/lib`:
+
+    `mkdir -p $PCL_PREFIX/lib`  
+    `mv -f $PCL_PREFIX/lib64/libpcl* $PCL_PREFIX/lib/.`  
+
+
+4. Use [Git](http://git-scm.com) to clone
+   the LPEL repository from [Github](https://github.com),
+   build and install it:
+
+    `git clone https://github.com/snetdev/lpel.git`  
+    `cd lpel`  
+    `./build-aux/bootstrap`  
+
+    `./configure --with-pcl=$PCL_PREFIX \`  
+    `            --with-mctx=pcl \`  
+    `            --prefix=$LPEL_PREFIX`    
 
     `make`  
     `make install`  
+    `cd ..`
 
 
-3. Extract the snet-runtime archive.
+5. Clone the snet-runtime repository from Github, build and install it:
 
+    `git clone https://github.com/snetdev/snet-rts.git`  
 
+    `cd snet-rts`  
+    `./bootstrap`  
 
-4. At the top-level of the runtime tree, run:  
+     `./configure --with-lpel-includes=$LPEL_PREFIX/include \`  
+     `            --with-lpel-libs=$LPEL_PREFIX/lib \`  
+     `            --prefix=$SNET_PREFIX`  
 
+     `make`  
+     `make install`  
 
-     `./configure --with-lpel-includes=<lpel_install_dir>/include \`  
-     `            --with-lpel-libs=<lpel_install_dir>/lib \`  
-     `            --prefix=<my_snet_dir>`  
 
-     `make                # this builds the run-time system`  
-     `make install        # moves files into place under <my_snet_dir>`  
+6. Define S-Net environment variables in your personal startup files
+   which are required to compile S-Net source code:
 
-     `export SNET_INCLUDES=<my_snet_dir>/include/snet`  
-     `export SNET_LIBS=<my_snet_dir>/lib/snet`  
-     `export SNET_MISC=<my_snet_dir>/share/snet`
+     `export SNET_INCLUDES=$SNET_PREFIX/include/snet`  
+     `export SNET_LIBS=$SNET_PREFIX/lib/snet`  
+     `export SNET_MISC=$SNET_PREFIX/share/snet`
 
 
 
-5. Set your library search path for S-Net and LPEL.  On Linux:
+7. Set your library search path for S-Net and LPEL.  On Linux:
 
-     `export LD_LIBRARY_PATH=$SNET_LIBS:<lpel_install_dir>:$LD_LIBRARY_PATH`  
+     `export LD_LIBRARY_PATH=$SNET_LIBS:$LPEL_PREFIX/lib:$LD_LIBRARY_PATH`  
 
      On OS X:
 
      `# on OS X, include $SNET_LIBS and LPEL in your DYLD_LIBRARY_PATH:`  
-     `export DYLD_LIBRARY_PATH=$SNET_LIBS:<lpel_install_dir>:$DYLD_LIBRARY_PATH`  
+     `export DYLD_LIBRARY_PATH=$SNET_LIBS:$LPEL_PREFIX/lib:$DYLD_LIBRARY_PATH`  
+
 
+8. Download the S-Net compiler archive and unpack it. The archive contains a compiled binary. For convenience you may want to consider placing the compiler binary into a directory in your $PATH.
 
-6. Download the S-Net compiler archive and unpack it. The archive contains a compiled binary. For convenience you may want to consider placing the compiler binary into a directory in your $PATH.
 
diff --git a/index.markdown b/index.markdown
@@ -2,9 +2,9 @@
 layout: pages
 title: S-Net Dev // Downloads
 ---
-Here you can download all the individual parts to build the S-Net tool chain.  
-Everything you need to get up and running with S-Net is listed on the right.   
-All parts, except for the compiler for the time being, are available as sources
+Welcome to the S-Net project on Github!
+All S-Net software, except for the compiler for the time being,
+are available as sources
 and are licensed under the LGPL.
 
 Have a look at the [How to Build Guide](content/howtobuild.html)
