Merge pull request #1981 from LeoColomb/Fix-Docs

Fix docs missings & improve dev scripts

.gitignore

@@ -17,11 +17,11 @@ apps/*
 
 # Some general ignore patterns
 
-build/
-obj/
+[Bb]uild/
+[Oo]bj/
 *.o
-Debug*/
-Release*/
+[Dd]ebug*/
+[Rr]elease*/
 *.mode*
 *.app/
 *.pyc
@@ -48,6 +48,8 @@ xcuserdata
 *.opensdf
 *.suo
 *.pdb
+*.ilk
+*.aps
 ipch/
 
 #Eclipse

apps/.gitignore

@@ -9,8 +9,6 @@
 /devApps/*/.project
 /devApps/*/.settings/
 
-!_Examples_Moved.txt
-
 # don't ignore the .gitignore file
 !.gitignore
 

docs/linux.md

@@ -151,5 +151,12 @@ issues, if you have some problem please post in the forum as much info
 as possible.
 
 
+Libs 
+----
+The `export/` folder contains necessary components that need to be exported with the application:
+contains .so (shared objects) that the app needs to run against this allows OF linux apps to be released in a very portable way  
+users of the apps shouldn't need to install anything besides glut (which should be installed in most cases).
+
+
 many thanks!! OFteam
 

docs/table_of_contents.md

@@ -20,6 +20,7 @@ Usage
 About
 -----
 * [Libraries](libraries.md) — Details about libraries.
+* [Serial](serial.md) — Details about serial communication.
 
 More
 ----

other/serialTest/.gitignore

@@ -1,7 +1,3 @@
-# 
 applet/serialTest.cpp.eep
 applet/serialTest.cpp.elf
 applet/serialTest.cpp.hex
-
-# Building files
-*.o

scripts/dev/ci.template

@@ -1,3 +1,3 @@
-<h1>Continuous Integration</h1>
+<h1>continuous integration</h1>
 <p>This page shows the results of a daily compile of openFrameworks and all the examples. If you see any error or warning and want to fix it, use github to send us a pull request with your changes</p>
 <p>This tests are being run on linux 64bit so other platforms could have different errors/warnings even if they don't appear here</p>

scripts/dev/create_package.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# $1 -> platform: win_cb, linux, linux64, vs, osx, osxSL, ios, all
+# $1 -> platform: win_cb, linux, linux64, vs, osx, ios, all
 # $2 -> version number: 006
 
 platform=$1
@@ -15,12 +15,6 @@ PG_BRANCH=master
 
 hostArch=`uname`
 
-#if [ "$platform" = "osxSL" ]; then
-#    platform="osx"
-#    runOSXSLScript=1
-#    echo "will make changes for snow leopard"
-#fi
-
 if [ "$platform" != "win_cb" ] && [ "$platform" != "linux" ] && [ "$platform" != "linux64" ] && [ "$platform" != "vs" ] && [ "$platform" != "osx" ] && [ "$platform" != "android" ] && [ "$platform" != "ios" ] && [ "$platform" != "all" ]; then
     echo usage: 
     echo ./create_package.sh platform version
@@ -33,7 +27,7 @@ if [ "$version" == "" ]; then
     echo usage: 
     echo ./create_package.sh platform version
     echo platform:
-    echo win_cb, linux, linux64, vs, osx, android, all
+    echo win_cb, linux, linux64, vs, osx, android, ios, all
     exit 1
 fi
 
@@ -127,12 +121,8 @@ function createPackage {
 
     #remove previously created package 
     cd $pkg_ofroot/..
-	#if [ $runOSXSLScript = 1 ]; then
-	#	rm -Rf of_v${pkg_version}_osxSL*
-	#else
-	    rm -Rf of_v${pkg_version}_${pkg_platform}.*
-		rm -Rf of_v${pkg_version}_${pkg_platform}_*
-    #fi
+	rm -Rf of_v${pkg_version}_${pkg_platform}.*
+	rm -Rf of_v${pkg_version}_${pkg_platform}_*
     echo "creating package $pkg_platform $version in $pkg_ofroot"
 
     #remove devApps folder
@@ -381,47 +371,28 @@ function createPackage {
 	fi
 
 
-	#download and copy OF compiled
-	cd $pkg_ofroot/libs/openFrameworksCompiled/lib/${pkg_platform}
-    if [ "$pkg_platform" = "win_cb" ]; then
-		wget http://openframeworks.cc/git_pkgs/OF_compiled/${pkg_platform}/openFrameworks.lib
-		wget http://openframeworks.cc/git_pkgs/OF_compiled/${pkg_platform}/openFrameworksDebug.lib
-	fi
-
-
-    #if snow leopard change 10.4u to 10.5
-    #if [ $runOSXSLScript = 1 ]; then
-    #    cd $pkg_ofroot
-    #    echo "replacing 10.4u with 10.5 for snow leopard"
-    #    find . -name '*.pbxproj' | xargs perl -pi -e 's/10\.4u/10\.5/g'
-    #    pkg_platform="osxSL"
-    #fi
-
     #choose readme
     cd $pkg_ofroot
     if [ "$platform" = "linux" ] || [ "$platform" = "linux64" ]; then
-        mv docs/linux.md readme
+        cp docs/linux.md INSTALL.md
     fi
 
     if [ "$platform" = "vs" ]; then
-        mv docs/visualstudio.md readme
+        cp docs/visualstudio.md INSTALL.md
     fi
 
     if [ "$platform" = "win_cb" ]; then
-        mv docs/codeblocks.md readme
+        cp docs/codeblocks.md INSTALL.md
     fi
 
     if [ "$platform" = "osx" ] || [ "$platform" = "ios" ]; then
-        mv docs/osx.md readme
+        cp docs/osx.md INSTALL.md
     fi
 
     if [ "$platform" = "android" ]; then
-        mv docs/android.md readme
+        cp docs/android.md INSTALL.md
     fi
 
-    rm readme.*
-    mv readme readme.txt
-
     rm CONTRIBUTING.md
 
     #copy empty example

scripts/dev/head.template

@@ -2,7 +2,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <script src="http://openframeworks.cc/js/shCore.js" type="text/javascript"></script>
 <script src="http://openframeworks.cc/js/shAutoloader.js" type="text/javascript"></script>
-<script src="http://openframeworks.cc}/js/shBrushCpp.js" type="text/javascript"></script>
+<script src="http://openframeworks.cc/js/shBrushCpp.js" type="text/javascript"></script>
 <script src="http://openframeworks.cc/js/shBrushJava.js" type="text/javascript"></script>
 <script src="http://openframeworks.cc/js/shBrushXml.js" type="text/javascript"></script>
 <link href="http://openframeworks.cc/css/shCore.css" rel="stylesheet" type="text/css" />

scripts/dev/nightlybuilds.template

@@ -1,4 +1,4 @@
-<h1>Nightly builds</h1>
+<h1>nightly builds</h1>
 <p>Here you can find a daily build of the develop branch of openFrameworks. This downloads can be unstable, if you want the latest stable release look in the <a href="http://openframeworks.cc/download">downloads page</a></p>
 
 <h2>Latest Nightly</h2>