From 071e9c20d409109e95a7d399c6fb1e9fabff8b1e Mon Sep 17 00:00:00 2001 From: gwen Date: Tue, 14 Aug 2018 12:03:47 +0200 Subject: [PATCH] doc : new git repository --- doc/getting-started.txt | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/doc/getting-started.txt b/doc/getting-started.txt index a2f6a74..509a1c4 100644 --- a/doc/getting-started.txt +++ b/doc/getting-started.txt @@ -5,10 +5,10 @@ Getting started What is options handling ? ================================= -Due to more and more available options required to set up an operating system, -compiler options or whatever, it became quite annoying to hand the necessary -options to where they are actually used and even more annoying to add new -options. To circumvent these problems the configuration control was +Due to more and more available options required to set up an operating system, +compiler options or whatever, it became quite annoying to hand the necessary +options to where they are actually used and even more annoying to add new +options. To circumvent these problems the configuration control was introduced... What is Tiramisu ? @@ -18,7 +18,7 @@ Tiramisu is an options handler and an options controller, which aims at producing flexible and fast options access. The main advantages are its access rules and the fact that the whole consistency is preserved at any time, see :doc:`consistency`. There is of course type and structure validations, but also -validations towards the whole options. Furthermore, options can be reached and +validations towards the whole options. Furthermore, options can be reached and changed according to the access rules from nearly everywhere in your appliance. Just the facts @@ -26,15 +26,20 @@ Just the facts .. _gettingtiramisu: +`tiramisu`\ 's home page is here_ + +.. _here: https://forge.cadoles.com/Cadoles/tiramisu + Download --------- + To obtain a copy of the sources, check it out from the repository using `git`. We suggest using `git` if one wants to access to the current developments. :: - git clone git://git.labs.libre-entreprise.org/tiramisu.git + git clone https://forge.cadoles.com/Cadoles/tiramisu.git This will get you a fresh checkout of the code repository in a local directory named ``tiramisu``. @@ -65,17 +70,17 @@ So by now, we have: - a namespace (which is `c` here) - the access of an option's value by the - attribute access way (here `bool`, which is a boolean option + attribute access way (here `bool`, which is a boolean option :class:`~tiramisu.option.BoolOption()`. -So, option objects are produced at the entry point `c` and then handed down to -where they are actually used when `c.bool` is triggered. This keeps options +So, option objects are produced at the entry point `c` and then handed down to +where they are actually used when `c.bool` is triggered. This keeps options local but available at any timer and consistent. -Once the namespace is created, we can set a +Once the namespace is created, we can set a :meth:`~config.CommonConfig.read_write()` access to the options:: >>> c.read_write() -which enables us to set a bunch of access rules that we wil explain later in +which enables us to set a bunch of access rules that we wil explain later in :doc:`status`.