[#333] New documentation structure

git_doc_en/behaviourchanges_en.md

@@ -0,0 +1,38 @@
+### Changes in behavior ###
+Some changes has been made to the overall behavior of the firmware from the original. This paragraph may be read by any new user not to think something is a "bug".
+
+* Stealth mode:  
+  The stealth mode has been extended to some more screens.  
+  The battery charging screen does no longer show up in stealth mode; only for a few seconds when plugging in the USB cable, just to show it's been correctly plugged.  
+  The Key Lock/UnLock screen reverts to black screen if keys are locked.  
+  The Stealth On/Off screen goes to black when setting stealth On.
+
+* Right (+) and Left (-) buttons:  
+  While editing some values, the speed of change has been made more progressive before reaching the insane terminal velocity.  
+  Pressing those buttons does no longer wake up the box from screen saving, except if configured to do so in the Interface menu (see below). This makes the box more pocket-proof.
+
+* Temperature setting in TEMP mode:  
+  The temperature no longer wraps-around by switching between °C and °F; the temperature unit has to be chosen once and for all in the Interface menu. Default is °C.  
+  The temperature setting can vary by +/1 °C or +/-5 °F when edited if configured to do so in the Interface menu (see below).
+
+* Fire button Multi-Clicks:  
+  Clicking rapidly 2, 3 or 4 times on the fire button may now have some effect - see below in the Interface menu description to see those effects and how to set (or unset) them up.  
+  Clicking 10 times for board temperature, or 20 times for version screen does no longer require to switch off the box.  
+
+* Coils memory:  
+  In POWER mode, the box now reminds of the power setting for any given resistance, up to 10 different (just like in SMART mode). Thus, when swapping between your tanks, the box will automatically set up the power setting you previously entered for that particular coil.  
+  Coils may vary by +/-10% in resistance to still be recognized, and two different coils within 10% won't be distinguished.
+  The coils memory can be erased in the Coils >> Manage >> Zero All menu item (see below).
+
+* Bypass mode:  
+  Power is now displayed on top of screen instead of voltage, as it's a more relevant information regarding vaping quality. Real-time output voltage information is still available as a third-line option (VOUT).  
+  Predicted power and voltage are also more accurate, especially on multi-cells boxes. It needs a few puffs to reach max accuracy, time for the box to estimate battery behavior under high load.
+
+* Logo:  
+  The myevic firmware accepts logos sizes of 64 pixels wide and from 40 to 63 lines high. Tall logo may partially recover lines of information in the center of the screen; it's up to you to choose the correct design and dimensions so that the display looks fine.
+
+* Menus:  
+  Menus accessed by pressing Fire and Right button have been completely revamped. See below for new menus description.
+-----
+
+← Previous Page: [Usage and Compatibility](usageandcompatibility_en.md) --  Next Page: [How To Build](howtobuild_en.md)→

git_doc_en/clock_en.md

@@ -0,0 +1,49 @@
+### Clock
+![Clock Menu](http://i345.photobucket.com/albums/p374/ClockSelect/eVic/clock_zpsmrvulkdd.png)
+
+* __Set Date/Time__
+
+  Setup date and time.
+  Fire change edited field, + and - set value, and long click on fire saves the setting. Since you need to click 2 seconds on the fire button to save, setup the time 2 seconds in advance if you want to achieve best accuracy. I know...
+
+  There is some other ways to setup time:
+  * use the ```evic-usb time``` command, if you installed the [python-evic](https://github.com/ClockSelect/python-evic "python-evic") command-line utility;
+  * use the Time synchronization function of the [NToolbox](https://github.com/TBXin/NFirmwareEditor/releases) of the NFirmwareEditor 6.0+; (check the time synch feature in the system tray).
+  * MicroSur's [FWUpdater](https://www.dropbox.com/s/83zd19gu05pl3r6/EvicVTCFont.rar?dl=1) also as a "Set current time" function.
+  * Joyetech's official firmware updater also sets date & time when uploading a firmware.  
+
+
+
+* __Fmt (date format)__
+
+  Toggle date display format between day.month.year (Western civilized world), month/day/year (US), day/month/year (Eastern civilized world), and year-month-day (Universe) format.
+
+  * __Size__
+
+    Toggle time display format of the digital dial between a small hh:mm:ss and a big HH:MM.
+
+  * __Dial__
+
+    Change the format of the clock display between a hand dial clock (A) and a digital clock with date and time (D). This will change the clock display on the main screen as well as on the screen saver, if the clock is chosen as screen saver.
+
+  * __Clk Adjust__
+
+    Adjust clock: for small adjustments to clock time + and - adjust clock by seconds. Fire to save. For VTwo owners, this option also adjusts the X32 frequency accordingly if done properly.
+
+  * __Clk Speed__
+
+    *This setting is useless on RTC-enabled boxes (VTwo/Dual, AIO, Basic, eGrip II)*  
+    *This setting is only usefull if you have set the Light Sleep mode "OFF" in the Expert menu. See below the "LSL" setting in the Expert menu description. As long as the Light Sleep mode is "ON" (default setting), there is no real need to adjust the Clock Speed Ratio.*  
+
+    Some boxes (VTC-Mini, Cuboid/Mini, Presa 75W, RX75, RX200S, RX2/3) does not have the needed 32kHz crystal soldered on the pcb to regulate the clock speed; so, another time source is used to drive the clock. Since its frequency is quite different, a clock speed ratio is needed to regulate the clock. As long as the box is awake (you're using it), the clock is regulated by the external 12.000MHz crystal, which is an accurate time source. Problem arises when the box enters sleep mode, since the crystal is switched off and the only clock source is the somewhat unreliable 10kHz internal oscillator of the processor. Clock drift mostly occurs when the box is switched off or sleeping.
+
+    The procedure to adjust the clock speed ratio is as follow:
+      * First, setup time accurately via the date/time menu or the "```evic-usb time```" command line.
+      * Let the box enter sleep mode (leave it alone or switch it off) for several hours. I suggest you're doing this before sleeping yourself.
+      * Awake the box and go into the "Clk Speed" menu; do not let the box enter sleep mode again in between, or you'll have to redo the whole thing.
+      * Using + and - buttons, adjust the time shown on top of the screen to catch up the real time. The number shown in the center of the screen is the clock speed ratio; reasonable values should be around 32~34000.
+      * Once you have adjusted the time to the real time, click fire to save the new clock speed ratio. Your clock should now be as accurate as it can. If not, try to repeat the procedure. Accuracy of a few seconds per day can be achieved this way.
+
+-----
+
+← Previous Page: [Vaping](vaping_en.md) --  Next Page: [Interface](interface_en.md)→

git_doc_en/coils_en.md

@@ -0,0 +1,47 @@
+### __Coils__
+
+* __Management__
+
+  ![](http://i345.photobucket.com/albums/p374/ClockSelect/eVic/coils_zpsn29ef1h5.png)
+
+* __On each line of the four TC modes:__
+
+  Click fire to toggle edit mode on the resistance.  
+  While the resistance value is highlighted, click (+) and (-) to edit its value.  
+  If you click fire again without editing the resistance value, this will toggle its locked/unlocked status.  
+  Editing the resistance to any non-zero value automaticaly locks it.  
+  Setting the resistance to zero with (-) will unlock and reset it.  
+
+  You may also fire two seconds on one of the four resistances to reset its value; if the selected resistance corresponds to the current vaping mode, this will force an immediate reading of the atomizer, setting and lock of the new value.  
+-----              
+When entering the Coils Management menu, the resistance corresponfing to the current vaping mode (if applicable) will be pre-selected.
+
+* __Zero All__
+
+  Zeroes all resistances; also zeroes all "SMART" and "POWER" modes saved resistance settings.
+
+* __Check: Yes/No__
+
+  If you feel you need to use this feature in any other situation than a really heavy build with low TCR value (SS and such), you surely have an issue with your coil. Using this feature may be risky and therefore is not recommended. Check your build first.*  
+
+  In TC modes, the box checks for suitability of the resistance the first time it is fired (i.e. each time the atomizer in screwed on or after box reset). The test is done in a way that can make heavy builds with low TCR value fail the test (really heavy, like dual twisted clapton or such; more than around 1.7 grams of metal). If a coil fails the first fire test, the box will enforce the power mode.  
+  If you know your heavy build is well done and suitable for temp control, you may set this option to "No". The box will bypass the first fire test and let you vape in the selected temp control mode.  
+
+    __Keeping the coil test disabled may get you into unpleasant situations. Use wisely.__
+
+* __TCR Submenu__
+
+  ![](https://www.dropbox.com/s/n09iy9nu57jnv18/tcrset.png?dl=1)  
+
+        
+  *This menu is also accessible by switching off the box and pressing both Fire and Right regulatory button (+) for 5 seconds.*  
+
+   In addition to the three usual TCR modes (M1, M2 & M3), the box standard presets for TEMP NI, TI and SS are editable. To edit one of the three preset modes:
+   * Select the mode you want to edit,
+   * Long fire to unlock the default (DEF) behavior; a reasonable value is proposed as a default starting value for edition,
+   * Edit the TCR value.
+   * Long fire to restore the default (DEF) behavior if needed.
+
+-----
+
+← Previous Page: [Screen Menu](screen_en.md) --  Next Page: [Vaping Menu](vaping_en.md)→

git_doc_en/expert_en.md

@@ -0,0 +1,86 @@
+### Expert
+
+Some advanced options.  
+Normal users should barely have anything to do with those options, and can live perfectly well without ever knowing they exist. 
+I do not recommend "testing" those options just to "see what it does". Deny responsability of everything etc. 
+You're supposed to have 18+, after all^^
+
+  * __USB__
+
+        Choose between several USB modes:
+     * HID: Normal operation mode - factory setting. Disables any other USB device than HID.
+       HID is always active, even in the two others modes of operation. This feature permits communication between the box and firmware utilities.
+
+     * COM: A virtual COM interface; mainly used for debugging with a COM terminal such as putty.
+       May be usefull if you are developping your own version of the firmware.
+
+     * DSK: A virtual drive to download the firmware file.
+     Connect the box to a PC, and a disk device will appear with a "MYEVIC.BIN" file. This can be read and copied. This file is an encoded firmware file that can be uploaded to another device using evic-usb or the official Joyetech/Wismec firmware tool.
+
+  * __DBG__
+
+    Enables or disables the debug informations mode. Once the DBG option is set to "ON", Debug informations can be shown/hidden by clicking fire button four times. This option is OFF by default to prevent users to inadvertendly mess up their screen. It's of no interest if you're not developping your own version of the firmware.
+
+  * __X32__
+
+    Enables or disables usage of the X32 crystal of the PCB.  
+    If this setting is "OFF", the firmware won't try to drive the Real-Time Clock with the 32.768kHz crystal. This may solve freezing issues on some malfunctionning boxes. This setting will be active at next reset.  
+    After reset, if the box cannot use the X32 to drive the RTC, this option will be set back to "OFF" and the Light Sleep feature will be enabled (see "LSL" below).  
+    *This option is useless and forced to "OFF" on boxes known not to have an X32 crystal. Those are all boxes for which the manufacturer did not enable the RTC feature, i.e: VTC-Mini, Cuboid/Mini, Presa 75W and RX series.*  
+
+  * __LSL__
+
+    Light Sleep mode.  
+    *This setting is useless and forced to "OFF" on boxes with a X32 crystal (VTwo/Dual, AIO, Basic, eGrip II), and defaults to "ON" on other boxes.*  
+    On boxes where the Real-Time Clock is emulated (like the VTC-Mini), by setting the Light Sleep mode "ON", the box continues to drive the Real-Time Clock with the external 12.000MHz Crystal instead of the internal LIRC oscillator when entering sleep mode. This makes the Clock far more accurate and eliminates the need for the Clock Speed ratio, at the cost of a greater battery consumption (estimated less than 50 mAh/day).  
+    Using this setting, Clock accuracy is identical to those of real RTC boxes.
+
+  * __NFE__
+
+    *Warning: You can't use Joyetech's firmware updater while this option is "ON". It may aloso cause issues with third-party firmware management systems.*  
+    Enables or disables partial compatibility with the [NFirmwareEditor 5.x](https://github.com/TBXin/NFirmwareEditor/releases) myEvic Configuration Editor.  
+    This option is disabled by default; set it to "ON" if you plan to use developpement features of the NFE. You'll have access to Monitoring, Screenshot, COM terminal, and Custom Battery Profile editor.  
+    Since compatibility is only partial at the moment, editing parameters other than Battery Profile will have no effect.  
+
+  * __SHR__
+
+    Shunt Resistance (in mΩ). (real resistance in Ohm now)
+    *Warning: This item is dangerous to your box. Messing with this parameter may cause overcurrent in the atomizer circuitry and lead to definitive box failure.*  
+    This item let you edit the value of the Atomizer's circuit shunt resistance. This resistance is involved in every resistance/current/power measures and computation in the whole firmware. This value should only be changed if you know exactly what you are doing.  
+    To reset the shunt value, select the SHR menu item and press the fire button during 2 seconds. This will revert the value to the default hardware setting.
+
+  * __UCH__
+
+    USB Battery Charging.  
+    *Multi-cell boxes only. This option has no effect on single-cell boxes.*  
+    Enables or disables battery charging via the USB port. The USB port is still usable for all other purposes: firmware management, debugging, etc.  
+    If you have an external battery charger and want to take care of your batteries, it is recommended to switch off the USB charging feature to avoid potentialy unbalanced charges, or unadapted charge currents at end of charge.
+
+  * __BAT__
+
+    Battery model.  
+    You can specify your battery brand and model among several ones: 25R, 30Q, HG2, HE4, VTC4, VTC5 and VTC6. "GEN" is the generic battery used by default and should be used for any other model of battery or for built-in battery.  
+
+    Custom Battery:  
+    By pressing the Fire button during two seconds while editing this option, the battery model changes to "CUS" (Custom Battery). The box will use the user-defined battery discharge curve and settings. Those informations can be edited using [NFirwareEditor](https://github.com/TBXin/NFirmwareEditor/releases) discharge profile editor (see [NFirwareEditor](https://github.com/TBXin/NFirmwareEditor/releases) documentation for more information).  
+    *The NFE compatibility mode must be set to ON in the expert menu for NFE to recognize the box as compatible.*
+
+    At the moment, battery model information is used by the firmware to compute a more accurate state-of-charge than the generic setting, and to avoid battery stress by limiting max Amp draw. Max Amps by battery model is based on Mooch's stress tests and are fairly reliable.  
+
+    *On boxes with built-in battery (AIO, Basic, eGrip II, Cuboid Mini), this option should be kept on the "GEN" setting unless you've taken your box apart and manualy replaced the internal battery pack by something else.*  
+
+  * __BVO__
+
+    Battery Voltage Offset submenu  
+    Corrective offset value of the battery voltage. Depending on your box, the displayed battery voltage may be off by a few tens of millivolts. It's usually not a concern, but it may make the box locking the vape too early (wasting some battery capacity) or too late (box resets due to low voltage when firing).  
+    Use an external accurate voltmeter (your battery charger may do the job) to compare the displayed voltages on the box to the actual battery voltages, then adjust the displayed voltages with this item.  
+    Range is -1.00 to +1.00 Volts by step of 10mV.  
+    * On a single-cell box, only the first setting (B1) is significant. B2 and B3 are ignored.  
+    * On a fixed dual-cells box, the two first settings (B1 & B2) are used, respectively, for the first and the second battery (depending on the box, you'll have to determine wich one wich with your voltmeter). B3 is ignored.  
+    * On a mixed single/dual-cells box, B1 is used for the lone battery in single-cell setting, and B2 & B3 for the two cells in a dual-cell setting.  
+    * On a triple-cell box, B4 is ignored.  
+    * On a quad-cell box, I let you guess.  
+
+-----
+
+← Previous Page: [Interface](interface_en.md) 

git_doc_en/howtobuild_en.md

@@ -0,0 +1,15 @@
+### Build
+Follow [evic-sdk::Readme](https://github.com/ReservedField/evic-sdk/blob/master/README.md) instructions to:
+
+  * Setup the environment
+
+  * Install python-evic
+
+  * Install and unpack nuvoton-sdk with the following changes:
+    * Unpack into this project directory (evic-sdk itself is not required for this project)
+    * When unpacking nuSDK unpack only ```Library``` directory. For example unpack ```M451 Series BSP CMSIS V3.01.001/Library``` from ```M451_Series_BSP_CMSIS_V3.01.001.zip``` to ```myevic/nuvoton-sdk/Library```
+
+  * To build invoke: ```EVICSDK=. make```
+-----
+
+← Previous Page: [Behaviour Changes](behaviourchanges_en.md) --  Next Page: [Profiles](profiles_en.md)→