From cdae1697def84d8458c2ed0b649be71f007689b1 Mon Sep 17 00:00:00 2001
From: gg64du02 <39301190+gg64du02@users.noreply.github.com>
Date: Wed, 13 Jun 2018 23:30:28 +0200
Subject: [PATCH] Adding tips to maintain the project

---
 TIPS_TO_MAINTAIN.md | 38 ++++++++++++++++++++++++++++++++++++++
 TODO.md             |  3 ++-
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 TIPS_TO_MAINTAIN.md

diff --git a/TIPS_TO_MAINTAIN.md b/TIPS_TO_MAINTAIN.md
new file mode 100644
index 0000000..30bb8c0
--- /dev/null
+++ b/TIPS_TO_MAINTAIN.md
@@ -0,0 +1,38 @@
+## duckSpark.js
+
+###  Convert the rubber ducky script to Arduino IDE friendly code.
+
+
+###  This will generate code containing those kind of lines:
+
+
+###  DigiKeyboard.delay(3000);
+
+
+#### straight foward, no comment.
+
+
+###  DigiKeyboard.println("notepad");
+
+
+#### println use the array scancode-ascii-table.h
+
+#### this array maps ascii's code -> scancode
+
+
+###  DigiKeyboard.sendKeyStroke(KEY_R,MOD_GUI_LEFT);
+
+###  DigiKeyboard.sendKeyStroke(KEY_ENTER);
+
+
+#### sendKeyStroke use scancodes defined with #define in DigiKeyboard.h
+
+
+## DigiKeyboard.h (vary with the target keyboard layout ie keyboard's language)
+
+###  Contains scancodes (#define at the beginnig of the file) for single keystroke and keystroke with modifiers.
+
+
+## scancode-ascii-table.h (vary with the target keyboard layout ie keyboard's language)
+
+###  Maps ascii-table to scancode
diff --git a/TODO.md b/TODO.md
index 83a6ac7..732491d 100644
--- a/TODO.md
+++ b/TODO.md
@@ -10,7 +10,7 @@ still works but you can't read the lines' number if you are on firefox
  multiOS 7 8 10 admin command prompt script
 
 # TODO: Try to came a with a single array generation during code translation (duckSpark.js)
-maybe it will save the lenght issue ?!?
+maybe it will save some RAM and allow more lenght ?!?
 
 # TODO: check support of this below string for french keyboard
 DigiKeyboard.println("abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ 1234567890ß ü+öä#,.- !"X$%&/()=? Ü*ÖÄ';:_ {[]}\~ <>| @§ ^´``");
@@ -100,6 +100,7 @@ w/ proper stylesheet ?
 
 # DONE: test chrome: works (58% marketshare)
 
+# DONE: add explaination about what is the main purpose of each files
 
 # =============================================================