Browse Source

Add build instruction to Readme

 - TODO complete other sections
 - Reorganize sections
Leo 10 years ago
parent
commit
96f78e8280
1 changed files with 35 additions and 4 deletions
  1. 35 4
      Readme.md

+ 35 - 4
Readme.md

@@ -1,6 +1,4 @@
-# OcLaunch
-
-## Licence
+# Licence
 
 This software is governed by the CeCILL license under French law and
 abiding by the rules of distribution of free software.  You can  use, 
@@ -8,4 +6,37 @@ modify and/ or redistribute the software under the terms of the CeCILL
 license as circulated by CEA, CNRS and INRIA at the following URL
 "http://www.cecill.info".
 
-OcLaunch is a command-line tool.
+# Descrition
+
+OcLaunch is a command-line tool to launch successively (each
+time the program is called) commands.    
+It is designed to be used with any program, interactive or
+not.
+
+
+# Installation
+
+## Usage
+
+## Getting started
+
+# Build from this repository
+
+The project has the following dependencies :
+```oasis, atdgen, yojson, core, core_extended```
+
+You can use the following command :
+
+```sh
+oasis setup
+./configure
+make
+```
+
+You can launch OcLaunch from both ./oclaunch.byte and
+./oclaunch.native
+
+### Ideas of program to use with
+
+ + [Taskwarrior](http://taskwarrior.org/ “Taskwarrior”)
+ + [Irssi](http://irssi.org/ “Irssi”)