Update documentation

README.md

@@ -1,44 +1,64 @@
 Debian Auto Installer
 ====================
 
-A set of tools to create automated Debian Installation Key. I created this tools
-for my work. You can create bios, efi64 key but prepare file in the folder
- whitout creating key.
+A script to create automated Debian Installation Key. I created it for my work.
+ You can create bios, efi64 key or prepare files into a folder whitout creating 
+key. 
  
  * init.sh : script to create USB key
  * preseed : textfile that contain all instructions for Debian Installer
  * partman : partition recipe for preseed
  * syslinux/syslinux.cfg : Syslinux configuration file
+ * conf/*.conf : "folder configuration" files
 
-# Howto create usb key
-
- 1. Plug your key
- 2. Make sure yout key is not mounted
- 3. Execute ``./init.sh -d /dev/sdb`` (replace /dev/sdb with your device)
- 4. Done!
 
 # Init.sh command line options
 
  * ``-a [amd64|i386]`` choose architecture for debian files (default amd64)
  * ``-b`` create key for bios boot architecture (default efi64)
+ * ``-c --conf`` set folder configuration files (default conf/archlinux.conf)
  * ``-d device`` USB device like /dev/sdb
+ * ``--debian-version`` debian iso version to download (default 8.7.1)
+ * ``--repo`` repository folder (default ./repo)
+ * ``--tmp`` Temporary folder used to create USB key to create directory tree 
 
 Be careful : if ``-d`` parameter is define then the relative peripheral will 
 be erased
 
-For now, this script doesn't verify the state of your device (is mounted or not)
- but this is planned.
+Since syslinux files are placed differently depending on the distribution,
+ configuration file (``-c``) contain directory to syslinux files :
  
-## Exemples
+ * syslinux_mbr_bl_folder : folder containing mbr.bin
+ * syslinux_efi_bl_folder : folder containing efi64 folder
+ * syslinux_modules_folder : folder containing syslinux modules folders
 
-Prepare file in directory for efi system without writing an usb key for AMD64 arch.
+## Examples
+
+Prepare file in directory for efi system without writing an usb key for AMD64.
 
 ```
 ./init.sh
 ```
 
-Prepare an usb key (/dev/sdb) for bios / i386 architecture
+Prepare an USB key (/dev/sdb) for bios / i386 architecture
 
 ```
 ./init.sh -a i386 -b -d /dev/sdb
 ```
+
+Prepare an USB key on Debian
+
+```
+./init.sh -d /dev/sdb -c conf/debian.conf
+```
+
+# How it work
+
+ - Create a repo folder then a subfolder named with debian version to 
+   download then download debian iso, vmlinuz and initrt.gz.
+ - Create a temporary folder and copy all necessary files into it (pressed,
+   partman recipes, syslinux modules...)
+ - If ``-d /dev/sdx``, unmount usb key( if mounted) and create partition scheme,
+   format and  mount partitions
+ - Copy all content of temporary folder into mounted usb key.
+ - Enjoy!