Add installation instructions in readme

README.md

@@ -1,51 +1,93 @@
 # Modified Klipper for the Creality Ender 3 V3 SE with display support 
 
-This project allows you to use the original Creality E3V3SE (Ender 3 V3 SE) display with Klipper. It is an improved version compared to the [first version, connected directly to the rpi gpios](https://github.com/jpcurti/E3V3SE_display_klipper).
+This is a modified [Klipper](https://www.klipper3d.org/) that supports the original **Creality E3V3SE (Ender 3 V3 SE)** display by combining [E4ST2W3ST serial bridge](https://github.com/Klipper3d/klipper/commit/6469418d73be6743a7130b50fdb5a57d311435ca) with the [ender 3 v3 se display interface](https://github.com/jpcurti/E3V3SE_display_klipper) to make it possible to use the printers display cable without any hardware modification. This repository is forked from [0XD3ADs klipper config](https://github.com/0xD34D/klipper_ender3_v3_se), but its commits can be applied separately from any other configuration. 
 
-![Demonstration image](docs/img/display_e3v3se_klipper.gif)
+![Demonstration image](docs/e3v3se_display/display_e3v3se_klipper.gif)
 
-Features that are not available are shown as a pop-up:
+## Installation
 
-![Demonstration image](https://github.com/jpcurti/E3V3SE_display_klipper/blob/main/docs/img/disabled_features.gif?raw=true)
+### Using pre-built binaries
+Copy the `.bin` file from a [release](https://github.com/jpcurti/ender3-v3-se-klipper-with-display/releases) to a SD card and flash it into your printer as you would do when installing klipper. **Note: remember to rename the file to a different filename as the last flashed binary, otherwise the printer won't recognize it as a new file and won't update.**
 
-## Supported features
+### By cloning the project and building it from source
+Clone the project, navigate to the repository directiory and configure your build with `make manuconfig`:
+```sh
+git clone https://github.com/jpcurti/ender3-v3-se-klipper-with-display
+cd ender3-v3-se-klipper-with-display
+make menuconfig
+```
+In the configuration menu, enable the serial bridge for **USART2** and the klipper parameters for the Ender 3 v3 se:
+![Demonstration image](docs/e3v3se_display/klipper_make_menuconfig_serial_bridge.png)
+
+After that, build your own binaries with `make`, copy the `klipper.bin` from the output folder to a SD card and flash as you would do with klipper.
+
+## Configuration
+A section called `[e3v3se_display]` need to be added to your `printer.cfg` to enable the display. Besides that, you can set a custom language and logging (defaulted as english and false, respectively), like:
 
+```yaml
+[e3v3se_display]
+language: portuguese
+logging: True
+```
+
+## Supported features
 The currently supported features are:
 
 | Feature                | Status  |
 | ---------------------- | ------- |
-| Print file             | ✗ |
-| Tune print             | ✗ |
-| Pause/continue print   | ✗ |
-| Stop print             | ✗ |
-| Move Axis              | ✗ |
-| Home Axis              | ✗ |
-| Set Z offset           | ✗ |
-| Disable step motors    | ✗ |
-| Preheat bed            | ✗ |
+| Print file             | ✓ |
+| Tune print             | ✓ |
+| Pause/continue print   | ✓ |
+| Stop print             | ✓ |
+| Move Axis              | ✓ |
+| Home Axis              | ✓ |
+| Set Z offset           | ✓ |
+| Disable step motors    | ✓ |
+| Preheat bed            | ✓ |
 | Cooldown               | ✗ |
-| Set nozzle temperature | ✗ |
-| Set bed temperature    | ✗ |
+| Set nozzle temperature | ✓ |
+| Set bed temperature    | ✓ |
 | Set max speed          | ✗ |
 | Set max acceleration   | ✗ |
 | Set steps per-mm       | ✗ |
 | Leveling Menu          | ✗ |
 
+Features that are not available are shown as a pop-up:
+
+![Demonstration image](https://github.com/jpcurti/E3V3SE_display_klipper/blob/main/docs/img/disabled_features.gif?raw=true)
+
+## Important
+-  This project is based on the **E3V3SE display firmware 1.0.6**. Any changes in the firmware version, such as a new version from Creality, can change the assets locations within the display memory and a new mapping would be necessary. A list of available firmware can be found [on Creality website](https://www.creality.com/pages/download-ender-3-v3-se) and a detailed instruction on how to update your display is available on [youtube](https://www.youtube.com/watch?v=8oRuCusCyUM&ab_channel=CrealityAfter-sale).
+
+## Related projects and credits:
+-  This repository is heavily based on the [DWIN_T5UIC1_LCD](https://github.com/odwdinc/DWIN_T5UIC1_LCD) repository for the E3V2 display and makes use of most of the available classes and methods implemented there, with the necessary modifications for the E3V3SE display. All credits goes to the [author of the DWIN_T5UIC1_LCD project](https://github.com/odwdinc) for making the version which this repository is based on.
+
+- This repository includes a proposed change proposed by [E4ST2W3ST](https://github.com/Klipper3d/klipper/commit/6469418d73be6743a7130b50fdb5a57d311435ca) to enable the MCU to act as a serial bridge between USB and the display serial port. Without his work, this project wouldn't exist.
+
+- This repository is forked and makes use of an already configuration for the ender 3 v3 se made by [0XD3ADs](https://github.com/0xD34D/klipper_ender3_v3_se), where a lot of different improvements were made.
+
+
+## FAQ
+
+### Printer is not flashing the .bin from the releases or built from source
+Please check if you are renaming the binaries between flashes as mentioned in the section [Using pre-built binaries](#using-pre-built-binaries)
+
+### After installing this project my display went crazy!
+Check if you installed the **E3V3SE display firmware 1.0.6** as mentioned in section [Important](#important)
+
+### I found a bug in the GUI or something doesn't work as expected
+Please [open an issue for bugs/feature requests](https://github.com/jpcurti/ender3-v3-se-klipper-with-display/issues) and make a question in the project [discussion](https://github.com/jpcurti/ender3-v3-se-klipper-with-display/discussions)
+
+## Other useful links
 
+https://www.klipper3d.org
 
-[![Klipper](docs/img/klipper-logo-small.png)](https://www.klipper3d.org/)
+https://octoprint.org/
 
-https://www.klipper3d.org/
+https://github.com/arksine/moonraker
 
-Klipper is a 3d-Printer firmware. It combines the power of a general
-purpose computer with one or more micro-controllers. See the
-[features document](https://www.klipper3d.org/Features.html) for more
-information on why you should use Klipper.
+https://github.com/odwdinc/DWIN_T5UIC1_LCD
 
-To begin using Klipper start by
-[installing](https://www.klipper3d.org/Installation.html) it.
+https://github.com/jpcurti/E3V3SE_display_klipper
 
-Klipper is Free Software. See the [license](COPYING) or read the
-[documentation](https://www.klipper3d.org/Overview.html). We depend on
-the generous support from our
-[sponsors](https://www.klipper3d.org/Sponsors.html).
+https://github.com/0xD34D/klipper_ender3_v3_se