From: Nathael Pajani <nathael.pajani@ed3l.fr>
Date: Sun, 5 Feb 2023 02:43:38 +0000 (+0100)
Subject: Update main Readme
X-Git-Url: http://git.techno-innov.fr/?a=commitdiff_plain;h=3c349f0b48037cb22e1521912f608c577192c0d5;p=soft%2Flpc122x%2Frfsub1GHz

Update main Readme
---

diff --git a/README b/README
index ee0bbce..f5fa2e8 100644
--- a/README
+++ b/README
@@ -1,31 +1,47 @@
 This repository provides example code for the RF-Sub1GHz modules made by
 Techno-Innov.
 
-Example applications are created in this directory, with one subdirectory
-for each example application. These are (and must stay) independent.
-
-More usefull stuff is up to you. Creating an app is *very* simple. Copy one of
-the examples to the name you want and start coding.
-** Please, no spaces (or special characters) in the directory names ! **
-
-Refer to the main README file (at the root of the core support git repository)
-for more information about building and flashing.
-
-
-If you did not get it yet, the core lpc122x support can be cloned from our
-server:
- git clone git://git.techno-innov.fr/soft/lpc122x/core
-You should then move this repository to the apps sub-directory of the core
-support repository.
-
-
-System Reference Manual and electronics sources for the modules can be found
-- on our server under this directory :
-	http://techdata.techno-innov.fr/Modules/RF-Sub1G/
-- on our Wiki :
-	http://wikifr.techno-innov.fr/index.php/Products/Module_RFSub1G
-- on our git :
-	http://git.techno-innov.fr/?p=elec/base (elec libraries for KiCaD)
-	http://git.techno-innov.fr/?p=elec/modules/rfsub1g (schematics RF Sub-1GHZ boards)
-	http://git.techno-innov.fr/?p=docs/rfsub1g (documentation)
 
+## Important :
+ These examples rely on the lpc122x core support git repository.
+
+## LPC122x core support :
+ If you did not get it yet, the lpc122x core support can be cloned from our
+ server:
+   git clone git://git.techno-innov.fr/soft/lpc122x/core
+ You should then move this repository to the apps sub-directory of the core
+ support repository.
+
+## Creating new applications :
+ Example applications are created in this directory, with one subdirectory
+ for each example application. Example applications are (and must stay)
+ independent.
+
+ More usefull stuff is up to you. Creating an app is *very* simple. Copy one of
+ the examples to the name you want and start coding.
+ ** Please, no spaces (or special characters) in the directory names ! **
+
+## Building and Flashing :
+ Refer to the README file at the root of the core support git repository (base)
+ for more information about building and flashing.
+
+
+## Documentation and sources :
+ System Reference Manual and electronic sources for the modules can be found
+  - on our server under this directory :
+    http://techdata.techno-innov.fr/Modules/RF-Sub1G/
+  - on our Wiki :
+    http://wikifr.techno-innov.fr/index.php/Products/Module_RFSub1G
+  - on our git :
+    http://git.techno-innov.fr/?p=elec/base (elec libraries for KiCaD)
+    http://git.techno-innov.fr/?p=elec/modules/rfsub1g (schematics RF Sub-1GHZ boards)
+    http://git.techno-innov.fr/?p=docs/rfsub1g (documentation)
+
+
+## List of examples :
+ - simple : simple example which displays temperature or voltage if receiving
+    the right request, and sends "lines" over RF.
+ - transparent_bridge : sends pre-formated data packet back and forth between
+    UART0 and 868MHz RF.
+ - rf_hopping : send data to peers on a configured channel, and go back to
+    lisstening on another channel.