Documentation

README.md

@@ -2,9 +2,9 @@
 
 This particular project was created to facilitate my testing with Redpill and I decided to share it with other users.
 
-It is still in alpha stage, with little documentation, but it is functional. I'm Brazilian and my English is not good, so I apologize for my translations.
+I'm Brazilian and my English is not good, so I apologize for my translations.
 
-I tried to make the system as user-friendly as possible, to make life easier. The loader automatically detects which device is being used, SATADom or USB, detecting its VID and PID correctly. redpill-lkm has been edited to allow booting the kernel without setting the variables related to network interfaces so the loader (and user) doesn't have to worry about that. The Jun's code that makes the zImage and Ramdisk patch is embedded, if there is a change in "zImage" or "rd.gz" by some smallupdate, the loader re-applies the patches. The most important kernel modules are built into the DSM ramdisk image for automatic peripheral detection.
+I tried to make the system as user-friendly as possible, to make life easier. The loader automatically detects which device is being used, SATADoM or USB, detecting its VID and PID correctly. redpill-lkm has been edited to allow booting the kernel without setting the variables related to network interfaces so the loader (and user) doesn't have to worry about that. The Jun's code that makes the zImage and Ramdisk patch is embedded, if there is a change in "zImage" or "rd.gz" by some smallupdate, the loader re-applies the patches. The most important kernel modules are built into the DSM ramdisk image for automatic peripheral detection.
 
 # Important
 
@@ -14,13 +14,15 @@ I tried to make the system as user-friendly as possible, to make life easier. Th
 
 ## The DSM kernel is compatible with SATA ports, not SAS/SCSI/etc. For device-tree models only SATA ports work. For the other models, another type of disks may work.
 
+## It is possible to use HBA cards, however SMART and serial # are only functional on DS3615xs, DS3617xs and DS3622xs+ models.
+
 # Use
 
-To use this project, download the latest image available and burn it to a USB stick or SATA disk-on-module. Set the PC to boot from the burned media and follow the informations on the screen. When booting, the user can call the "menu.sh" command from the computer itself, access via SSH or use the virtual terminal (ttyd) by typing the address provided on the screen (http://(ip):7681). The loader will automatically increase the size of the last partition and use this space as cache if it is larger than 2GiB.
+## General
 
-The menu system is dynamic and I hope it is intuitive enough that the user can use it without any problems. Its allows you to choose a model, the existing buildnumber for the chosen model, type or randomly create a serial number, add/remove addons, add/remove/view "cmdline" and "synoinfo" entries, choose the LKM version, create the loader, boot, manually edit the configuration file, choose a keymap, update and exit.
+To use this project, download the latest image available and burn it to a USB stick or SATA disk-on-module. Set the PC to boot from the burned media and follow the informations on the screen. When booting, the user can call the "menu.sh" command from the computer itself, access via SSH or use the virtual terminal (ttyd) by typing the address provided on the screen `http://<ip>:7681`. The loader will automatically increase the size of the last partition and use this space as cache if it is larger than 2GiB.
 
-Changing addons and synoinfo entries require re-creating the loader, cmdline entries do not.
+The menu system is dynamic and I hope it is intuitive enough that the user can use it without any problems.
 
 There is no need to configure the VID/PID (if using a USB stick) or define the MAC Addresses of the network interfaces. If the user wants to modify the MAC Address of any interface, uses the "Change MAC" into "cmdline" menu.
 
@@ -30,6 +32,33 @@ Another important point is that the loader detects whether or not the CPU has th
 
 I developed a simple patch to no longer display the DUMMY port error on models without device-tree, the user will be able to install without having to worry about it.
 
+## Quickstart guide
+
+After booting the loader, the following screen should appear. Type menu.sh and press `<ENTER>`:
+![](doc/first-screen.png)
+
+If you prefer, you can access it via the web:
+![](doc/ttyd.png)
+
+Select the "model" option and choose the model you prefer:
+![](doc/model.png)
+
+Select the "Buildnumber" option and choose the first option:
+![](doc/buildnumber.png)
+
+Select the "Build" option and wait for the loader to be generated:
+![](doc/making.png)
+
+Select the "Boot" option and wait for the DSM to boot:
+![](doc/DSM%20boot.png)
+
+The DSM kernel does not display messages on the screen, so it is necessary to continue the process of configuring DSM through the browser by accessing the address `http://<ip>`.
+There are several tutorials on how to configure DSM over the internet, which will not be covered here.
+
+# Troubles/questions/etc
+
+Please use the Issues from github
+
 # Thanks
 
 All code was based on the work of TTG, pocopico, jumkey and others involved in continuing TTG's original redpill-load project.