Author: smaisonneuve Date: 2015-06-10 08:13:47 +0000 (Wed, 10 Jun 2015) New Revision: 1680 Url: http://forge.nuiton.org/projects/sandbox/repository/revisions/1680 Log: [Doc] - Adding readme in each project Added: oipf/emulator/readme.txt oipf/lib/readme.txt oipf/test/readme.txt Added: oipf/emulator/readme.txt =================================================================== --- oipf/emulator/readme.txt (rev 0) +++ oipf/emulator/readme.txt 2015-06-10 08:13:47 UTC (rev 1680) @@ -0,0 +1,3 @@ +This project is a web project built on top of oipf implementation. It gives you the ability to use the oipf implementation directly on your local machine. + +To launch the project, run node server.js and browse http://<ip address of your machine>:4000 Added: oipf/lib/readme.txt =================================================================== --- oipf/lib/readme.txt (rev 0) +++ oipf/lib/readme.txt 2015-06-10 08:13:47 UTC (rev 1680) @@ -0,0 +1,13 @@ +This project is an implementation of oipf standard. You compile it and use it as a library. + +To build the project, you need to install the require dependencies : +> npm install + +then install Gulp : +> npm install gulp -g + +and finally, run gulp : +> gulp + +The gulp task is watching for change within the oipf project files. If you make a change, the project will be automatically rebuilt. +The building process produce a js bundle under build/ directory. It also copy the static files that the library need to work. If you want to use this library in another project, you need to point to that directory or embed the files within the build dir. Added: oipf/test/readme.txt =================================================================== --- oipf/test/readme.txt (rev 0) +++ oipf/test/readme.txt 2015-06-10 08:13:47 UTC (rev 1680) @@ -0,0 +1,6 @@ +This is project contains unit test for oipf implementation. You can run it on a machine to determine how well it handle oipf : it will gives you a feedback on what part of the spec is supported or not. + +To run the project, run : +> node server.js + +Then browse http://<ip address of your machine>:3000