Update README.md

README.md

@@ -8,7 +8,7 @@ Stand-alone IP KVM device with a web interface with various video capture option
 - Advanced HID emulator based on one Arduino board. It has mouse support; keyboard works perfectly in a BIOS. The firmware implements a protocol with a check for transmission errors, it will never just hang.
 - Control the power of the server through the ATX button connectors on the motherboard and get the status of the power LEDs and hard drive activity.
 - Mass-storage device based on a flash drive. Now we use a regular USB drive whose contacts switch between the Pi and server using a relay.
-- The Ability to use any video capture device.
+- The ability to use any video capture device.
 - [Our own MJPG streamer](https://github.com/pikvm/ustreamer) written on C with support for multi-threading and GPU video encoding. It can change the resolution in real time for an HDMI source, report statistics about the video and much more (see [README](https://github.com/pikvm/ustreamer/blob/master/README.md) for detalis).
 - IPMI BMC support. You can use `ipmitool` for power management in your existing network infrastructure.
 - Extensible authorization methods - you can configure multiple KVMs so that they use a common authorization service.
@@ -18,17 +18,17 @@ Stand-alone IP KVM device with a web interface with various video capture option
 - A ready-to-use operating system that can be assembled just using `make build` and installed to a memory card using `make install`.
 
 
-## Minimal hardware implementation
+## Minimal hardware
 - Raspberry Pi 2, 3 or 4 (work in progress)
 - MicroSD card
 - Raspberry Pi power supply
 
 **Video capture side for lowcost S-Video**
-- Easycap UTV007 device (https://www.amazon.com/dp/B0126O0RDC)
+- [Easycap UTV007 device](https://www.amazon.com/dp/B0126O0RDC)
-- HDMI to S-Video (not all options work, but these three have been tested) (https://aliexpress.com/item/32847786071.html (for PCB (see bellow)) or https://www.amazon.com/dp/B012MDMWLM or https://www.amazon.com/gp/product/B01E56CV42)
+- HDMI to S-Video converter (not all options work, but these three has been tested) ([1](https://aliexpress.com/item/32847786071.html) (for PCB (see bellow)) or [2](https://www.amazon.com/dp/B012MDMWLM) or [3](https://www.amazon.com/gp/product/B01E56CV42))
   
 **Video capture side for HDMI**
-- B101 HDMI to CSI-2 Bridge (https://auvidea.eu/b101-hdmi-to-csi-2-bridge-15-pin-fpc/)
+- [Auvidea B101 HDMI to CSI-2 Bridge](https://auvidea.eu/b101-hdmi-to-csi-2-bridge-15-pin-fpc)
 
 **HID Subsystem and ATX control**
 - Arduino Pro Micro (ATMega32u4) with hardware USB for HID sub-system
@@ -64,23 +64,23 @@ Pi-KVM OS is based on Arch Linux ARM and contains all required packages and conf
 
 0. For a clean OS (Like Ubuntu 18) you need to install and configure docker (after adding user in the docker group a relogin is needed), as well as git and make.
     ```shell
-    $ sudo apt-get install git make curl -y
+    [user@localhost ~]$ sudo apt-get install git make curl -y
-    $ curl -fsSL https://get.docker.com -o get-docker.sh
+    [user@localhost ~]$ curl -fsSL https://get.docker.com -o get-docker.sh
-    $ sudo sh get-docker.sh
+    [user@localhost ~]$ sudo sh get-docker.sh
-    $ sudo usermod -aG docker user
+    [user@localhost ~]$ sudo usermod -aG docker user
     ```
 
 1. Checkout build toolchain:
     ```shell
-    $ git clone https://github.com/pikvm/os
+    [user@localhost ~]$ git clone https://github.com/pikvm/os
-    $ cd os
+    [user@localhost ~]$ cd os
     ```
 
 2. Determine the target hardware configuration (platform). If you are using an analog VGA video capture device, choose `v0-vga`. If you want to use HDMI with Auvidea B101, choose `v0-hdmi`. Other options are for specialized Pi-KVM boards (WIP).
 
 3. Create config file `config.mk` for the target system. You must specify the path to the SD card on your local computer (this will be used to format and install the system) and the version of your Raspberry Pi and platform. You can change other parameters as you wish:
     ```Makefile
-    $ cat config.mk
+    [user@localhost ~]$ cat config.mk
     # rpi3 for any Raspberry Pi 3, rpi2 for version 2.
     BOARD = rpi3
     
@@ -111,28 +111,47 @@ Pi-KVM OS is based on Arch Linux ARM and contains all required packages and conf
 
 4. Build OS. It may take about an hour depending on your Internet connection:
     ```shell
-    $ make os
+    [user@localhost ~]$ make os
     ```
     
 5. Put SD card into card reader and install OS:
     ```shell
-    $ make install
+    [user@localhost ~]$ make install
     ```
     
-6. After installation remove the SD card and insert it into your Raspberry Pi. Turn on the power. Raspberry Pi will try to get ad IP address using DHCP on your LAN. Congratulations! Your Pi-KVM will be available via SSH (`ssh root@<addr>`) and HTTPS (try to open it in a browser at `https://<addr>`). For HTTPS a self-signed certificate is used by default.
+6. After installation remove the SD card and insert it into your RPi. Turn on the power. RPi will try to get ad IP address using DHCP on your LAN. It will be available via SSH.
 
-7. If you cannot find the device's address, try using the following command:
+7. If you can't find the device's address, try using the following command:
     ```shell
-    $ make scan
+    [user@localhost ~]$ make scan
     ```
 
-Everything will be done for the Pi3 and Pi0 automatically with the video input defaulting to s-video.
+8. Now you need to flash Arduino. This can be done using your RPi. **Before starting this operation, disconnect the RESET wire from Arduino, otherwise the firmware will not be uploaded. Connect the Arduino and RPi with a suitable USB cable.** Log in to RPi and upload the firmware. Then connect RESET wire back, disconnect USB and reboot RPi.
-
+    ```
-Be sure to check the bottom of this README for [Tips](#tips) and [Troubleshooting](#troubleshooting)!
+    [user@localhost ~]$ ssh root@<addr>
+    [root@pikvm ~]# rw
+    [root@pikvm ~]# systemctl stop kvmd
+    [root@pikvm ~]# cp -r /usr/share/kvmd/hid ~
+    [root@pikvm ~]# cd ~/hid
+    [root@pikvm ~]# make
+    [root@pikvm ~]# make install
+    [root@pikvm ~]# reboot
+    ```
+9. Congratulations! Your Pi-KVM will be available via SSH (`ssh root@<addr>`) and HTTPS (try to open it in a browser at `https://<addr>`). For HTTPS a self-signed certificate is used by default.
 
 ## Tips
 ...
 
 ## Troubleshooting
-If you have any problems or questions, you can contact us using Discord: https://discord.gg/bpmXfz5
+* In step 8 (`make install`), you may encounter the following error:
+    ```
+    /root/.platformio/packages/tool-avrdude/avrdude: error while loading shared libraries: libtinfo.so.5: cannot open shared object file: No such file or directory
+    ```
+    Create a symlink for this library:
+    ```bash
+    [root@pikvm ~]# ln -s /usr/lib/libtinfo.so.6 /usr/lib/libtinfo.so.5
+    ```
+    And run `make install` again.
+
+* If you have any problems or questions, you can contact us using Discord: https://discord.gg/bpmXfz5