Docs: Created README.md

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rolando Rio Garaboa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+<div style="display:flex; flex-direction:row; justify-content:center; align-items:center; align-content:center; justify-items:center; width:100%;">
+    <img src="https://raw.githubusercontent.com/R0land013/showly/37a9f0b60eced03e2413b751f0babf7b0580d860/readme_assets/logo.svg" alt="Logo" style="height:50%; width:50%">
+</div>
+
+# Showly desktop
+
+Showly is an app to display your slides to other people if you do not have large
+screens or projectors to show it easily. Showly desktop supports Linux and Windows,
+it has not been tested on MacOS yet.
+
+## How it works
+
+When you run Showly desktop you will need to be connected to a LAN network, so
+your slides can be shared through that network. All participants of your
+talk will connect to the showly instance that is running on your pc using their
+web browsers on their pc or smartphones and they will see every single slide on it.
+
+The following diagram shows how it would be:
+
+<div style="display:flex; flex-direction:row; justify-content:center; align-items:center; align-content:center; justify-items:center; width:100%;">
+    <img src="readme_assets/how-it-works-diagram.jpg" alt="Logo" style="width:60%">
+</div>
+
+## How to run
+
+To run Showly desktop you will need to have [JDK 17](https://jdk.java.net/archive/) installed
+on your system. You can check if you have the correct JDK version running:
+
+```sh
+java --version
+```
+
+Then you have to download the latest version of Showly desktop from the [releases page](https://github.com/R0land013/showly-desktop/releases).
+Now, to run the program you have to open your Terminal in the same directory where
+you downloaded the showly app and execute the following command:
+
+```sh
+java -jar name_of_the_file_you_downloaded.jar
+```
+
+If you have configured your system to open **.jar** files, then you could open the program
+double clicking the .jar file.
+
+## Troubleshooting
+
+if the participants of your talk are unable to see the slides on their web browsers you
+can try these things to fix the problem:
+
+- Assert that the showly process is showing the slides.
+- Check you are connected to the same LAN network as your participants.
+- Assert the showly program is allowed through your firewall.
+- Check the port you are using to run showly is allowed through your firewall.
+
+## Contribute and Development
+
+Showly desktop is a GUI wrapper of [showly package](https://github.com/R0land013/showly), so if
+you are a developer and want to make your own Showly GUI, you are able to do it wrapping that
+package as I did.
+
+The requirements of this project are:
+
+- [Maven 3.8.8 or higher](https://maven.apache.org/)
+- [JDK 17](https://jdk.java.net/archive/)
+
+If you wish to contribute with new features, ideas and bug fixes you can always open an issue.
+
+## License
+
+This project is under [MIT LICENSE](/LICENSE).
+
+## Contact
+
+You can find my contact info [here](https://r0land013.github.io/).