Add a more comprehensive readme file

README.md

@@ -1,6 +1,15 @@
 # lcmlog
 Client side of a tool for reading and writing the lcm staff logs (both admins and 150). Requests are sent via ssh using user's account.
 
+## TL;DR: Installation and basic usage
+To install this software, simply clone this repository to your preferred machine; the machine doesn't have to be in the same subnet as the log server, the only requirement being that the server is reachable via SSH (through jumps, if needed).
+
+Usage: `lcmlog [-g] [-p]`. Currently supported methods are GET (`-g`) to print stored logs and POST (`-p`) to add new logs to the server.
+When running the software for the first time, regardless of the selected method, you will be prompted to open and edit a new configuration file with the editor corresponding to your `EDITOR` environment variable (default: `nano`).
+Write it as an SSH-config file (`~/.ssh/config`); this is used by the software to contact your log server.
+
+For any further questions, either run `lcmlog -h` or read the rest of this README.
+
 ## Methods
 
 #### GET
@@ -36,8 +45,8 @@ After the generation, you should edit the file and add the correct `HostName` (a
 You can't use this program until the config file is generated in the default folder (`~/.config/lcmlog`).
 
 ## Editor
-The default editor is `nano`. If you want to use another editor, currently you have to edit the source code and change the variable `EDITOR`. In a future update, this customization will be included in the configuration file.
+The default editor is `nano`. If you want to use another editor, your best shot is `export`ing the `EDITOR` variable from your shell (e.g. `export EDITOR=vim`). In a future update, this customization will be included in the configuration file.
 
 ## TODO
-[ ] Implement custom editor in the configuration file.
-[ ] Implement the `UPDATE` method
+- [ ] Implement custom editor in the configuration file.
+- [ ] Implement the `UPDATE` method