clean markdown documentation

[src/app-framework-main.git] / docs / 2.1-widgets.md

diff --git a/docs/2.1-widgets.md b/docs/2.1-widgets.md
index d1777c8..084ee98 100644 (file)
--- a/docs/2.1-widgets.md
+++ b/docs/2.1-widgets.md
@@ -1,7 +1,6 @@
-Tools for managing widgets
---------------------------
+# Tools for managing widgets
 
-This project includes tools for managing widgets.
+This project includes tools for managing widgets.  
 These tools are:
 
 - ***wgtpkg-info***: command line tool to display
@@ -19,31 +18,29 @@ These tools are:
 For all these commands, a tiny help is available with
 options **-h** or **--help**.
 
-There is no tool for unpacking a widget. For doing such operation,
-you can use the command **unzip**.
+There is no tool for unpacking a widget.  
+For doing such operation, you can use the command **unzip**.
 
 To list the files of a widget:
 
 ```bash
-$ unzip -l WIDGET
+unzip -l WIDGET
 ```
 
 To extract a widget in some directory:
 
 ```bash
-$ unzip WIDGET -d DIRECTORY
+unzip WIDGET -d DIRECTORY
 ```
 
-*Note that DIRECTORY will be created if needed*.
+*Note: that DIRECTORY will be created if needed*.
 
-Getting data about a widget file
----------------------------------
+## Getting data about a widget file
 
 The command **wgtpkg-info** opens a widget file, reads its **config.xml**
 file and displays its content in a human readable way.
 
-Signing and packing widget
---------------------------
+## Signing and packing widget
 
 ### Signing
 
@@ -57,13 +54,13 @@ There are two types of signature files: author and distributor.
 Example 1: add an author signature
 
 ```bash
-$ wgtpkg-sign -a -k me.key.pem -c me.cert.pem DIRECTORY
+wgtpkg-sign -a -k me.key.pem -c me.cert.pem DIRECTORY
 ```
 
 Example 2: add a distributor signature
 
 ```bash
-$ wgtpkg-sign -k authority.key.pem -c authority.cert.pem DIRECTORY
+wgtpkg-sign -k authority.key.pem -c authority.cert.pem DIRECTORY
 ```
 
 ### Packing
@@ -72,36 +69,36 @@ This operation can be done using the command **zip** but
 we provide the tool **wgtpkg-pack** that may add checking.
 
 Example:
+
 ```bash
-$ wgtpkg-pack DIRECTORY -o file.wgt
+wgtpkg-pack DIRECTORY -o file.wgt
 ```
-Writing a widget
-----------------
+
+## Writing a widget
 
 ### The steps for writing a widget
 
 1. make your application
-
-2. create its configuration file **config.xml**
-
-3. sign it
-
-4. pack it
+1. create its configuration file **config.xml**
+1. sign it
+1. pack it
 
 Fairly easy, no?
 
-Organization of directory of applications
------------------------------------------
+## Organization of directory of applications
 
 ### directory where are stored applications
 
-Applications can be installed in different places: the system itself, extension device.
+Applications can be installed in different places:
+
+- the system itself, extension device.
+
 On a phone application are typically installed on the sd card.
 
 This translates to:
 
- - /usr/applications: system wide applications
- - /opt/applications: removable applications
+- /usr/applications: system wide applications
+- /opt/applications: removable applications
 
 From here those paths are referenced as: "APPDIR".
 
@@ -109,16 +106,17 @@ The main path for applications is: APPDIR/PKGID/VER.
 
 Where:
 
- - APPDIR is as defined above
- - PKGID is a directory whose name is the package identifier
- - VER is the version of the package MAJOR.MINOR
+- APPDIR is as defined above
+- PKGID is a directory whose name is the package identifier
+- VER is the version of the package MAJOR.MINOR
 
-This organization has the advantage to allow several versions to leave together.
+This organization has the advantage to allow several versions
+to leave together.  
 This is needed for some good reasons (rolling back) and also for less good reasons (user habits).
 
 ### Identity of installed files
 
-All files are installed as user "afm" and group "afm".
+All files are installed as user "afm" and group "afm".  
 All files have rw(x) for user and r-(x) for group and others.
 
 This allows every user to read every file.