aboutsummaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rwxr-xr-xreadme.rst45
1 files changed, 33 insertions, 12 deletions
diff --git a/readme.rst b/readme.rst
index 755b289..3a7ed17 100755
--- a/readme.rst
+++ b/readme.rst
@@ -6,27 +6,49 @@
.. contents::
:depth: 3
+Licht is a console spreadsheet. This application allow you to view, edit, and
+save spreadsheet in Open document format.
+
+=======
+Licence
+=======
+
+Licht is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+licht is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+licht. If not, see <http://www.gnu.org/licenses/>.
+
===========
Compilation
===========
-licht requires ocaml 4.04 and ncurses
-
+licht requires ocaml 4.06, ncurses and gmp. The easest way to compile it is to
+use opam :
.. code-block:: console
- # sudo aptitude install opam libncures-dev libiconv-dev
- $ opam install ocamlbuild curses camlzip ezxmlm ounit text menhir zarith base
- $ make
+ # sudo aptitude install opam libncures-dev libiconv-dev libgmp-dev
+ $ opam pin add licht http://git.chimrod.com/cgit.cgi/licht.git
=====
Usage
=====
+Run licht with `licht` or `licht file.ods` in order to load a file.
+
Modes
=====
-You can switch between differents mode :
+Licht is a modal application. When you start the spreadsheet, you are in
+`Normal mode`_, which allow you to navigate in the sheet, and switch to others
+modes.
Normal mode
-----------
@@ -38,7 +60,6 @@ Key Action
======= ===========================
**v** switch to `selection mode`_
**:** Insert commands_
-**/** Search for a value
**e** edit a cell content (`edition mode`_)
**=** insert a formula (`edition mode`_)
**y** yank a cell
@@ -101,8 +122,8 @@ Date
Date are represented with this format `YYYY/MM/DD`. Any operation that can
apply to Numeric can also by applied to Date.
-Bool
-----
+Boolean
+-------
This type cannot be created directly. You can instead use the function `true()`
and `false()` or comparaison operator.
@@ -130,7 +151,7 @@ Undefined
~~~~~~~~~
If a reference point to an an empty cell, the content will be interpreted as
-Undefined. Any formula impliyng Undefined will return Error
+Undefined. Any formula impliyng `Undefined` will return Error
Functions
=========
@@ -138,12 +159,12 @@ Functions
You can enter a formula by starting the value with `=`. The evaluation always
expands the reference to other cells.
-Licht is provided with built-in functions.
+Licht is provided with built-in functions :
Generic comparaison
-------------------
-Thoses function can be applied to any value.
+Thoses function can be applied to any value, and return a Boolean.
=============== ===============================
Function Value