Added some documentation with info, build guide and guide to the JSON file format

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f66c95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# FlashRunner #
+
+FlashRunner is flash player program that doesn't use any emulation and runs on windows, mac and linux.
+FlashRunner is mainly made for flash games but can be used for any swf file.
+
+**How to build**
+
+1. Run setup_dependencies.sh (if on linux) or setup_dependencies_win.bat (if on windows) and wait for dependencies to install
+2. Run the build script that is for making the build you want to make
+- build_flashrunner_linux_x64.sh builds for Linux x86_64 (64-bit linux)
+- build_flashrunner_win32_x64.bat builds for Windows x86_64 (64-bit windows, this is to be run on windows if building on windows)
+- build_flashrunner_win32_x64.sh builds for Windows x86_64 using Wine (This is to make windows build under linux, requires Wine)
+
+3. Depending on which build you created the output will be in one of these following directories:
+- FlashRunner-win32-x64
+- FlashRunner-linux-x64
+
+** The format of the games list JSON file (flashrunner_game_list.json) **
+
+flashrunner_game_list.json file contains the menu items in "Choose from list"
+
+The file format is in the main JSON object there is array called "games_menu" which contains array of objects that each has "game_name" string
+that is name displayed in games menu and "game_swf" which contains string that is the link to the .swf file
+
+Example of the format:
+    {
+        "games_menu": [
+            {
+                "game_name": "Name of game 1 (first item in menu)",
+                "game_swf": "https://example.com/game1.swf"
+            },
+            {
+                "game_name": "Name of game 2 (second item in menu)",
+                "game_swf": "https://example.com/game2.swf"
+            }
+        ]
+    }
\ No newline at end of file