Adds requirements page

Imbick · Jun 9, 2019 · 061c4ea · 061c4ea
1 parent eefe3cb
commit 061c4ea
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,6 +3,8 @@ Ecka
 
 Ecka allows you to control Star Citizen from your touch screen devices.
 
+Ecka runs entirely on your local network. No information is sent out over the internet and stays between the devices you choose to connect to Ecka.
+
 .. Original content below
 .. Ecka is a cross platform automation application that runs locally on your devices.
 .. Ecka allows you to create flows that when triggered will run steps that you can configure.
@@ -16,6 +18,7 @@ Ecka allows you to control Star Citizen from your touch screen devices.
    :caption: User guide
 
    user-guide/quick-start
+   user-guide/requirements
    .. user-guide/installing
    user-guide/troubleshooting
    user-guide/flows/index

diff --git a/docs/source/user-guide/quick-start.rst b/docs/source/user-guide/quick-start.rst
@@ -1,10 +1,10 @@
 Quick start
 ===========
 
-* Once `downloaded <http://ecka.imbick.com/download>`_, extract Ecka to any folder on your computer. We recommend the desktop.
+* Once `downloaded <http://ecka.imbick.com/download>`_, extract Ecka to a folder on your computer.
 * Open the `appsettings.json` file in the root of the Ecka folder and change the `installPath` setting of the `Ecka.StarCitizen.Plugin` plugin section to match the location of where Star Citizen is installed on your machine. The default is `c:\\program files\\roberts space industries\\starcitizen\\live\\bin64\\`
-* Run `ecka.launcher.windows.exe` and you'll see the Ecka logo appear in the notification area.
-* Once Ecka is running it will open the welcome screen in your browser.
+* Run `ecka.launcher.windows.exe`.
+* Once it's running it will open the Ecka welcome screen in your browser.
 * If you have only one connected network adapter or LAN IP address;
    * The welcome page will show you the IP address that you can use to connect your secondary device.
    * Either type this address in full into your second device's browser or scan the QR code to quickly open the correct address on your device.
@@ -14,10 +14,10 @@ Quick start
    * Then either type the displayed address in full into your second device's browser or scan the QR code to quickly open the correct address on your device.
 * If no connected network adapter or LAN IP address is found you will only be able to connect to Ecka on the device it is running on;
    * Click the displayed link to open the page in your local browser.
-* Once you see the Star Citizen flight screen you are ready to launch Star Citizen.
-* Whilst Star Citizen is loading copy the `ecka.xml` control profile from the `\\Plugins\\Ecka.StarCitizen.Plugin.0.0.1\\` folder into your Star Citizen control profile folder at `\\StarCitizen\\LIVE\\user\\Controls\\Mappings\\`.
+* Once you see the Star Citizen flight screen on your second device you are ready to launch Star Citizen.
+* Whilst Star Citizen is loading copy the `ecka.xml` control profile from the `\\Plugins\\Ecka.StarCitizen.Plugin.0.0.1\\` folder into your Star Citizen control profile folder at `[installPath]\\StarCitizen\\LIVE\\user\\Controls\\Mappings\\`.
 * Once Star Citizen is up and running the last thing to do is apply the control profile by typing the command `pp_RebindKeys ecka` into the console.
-   * You can access the console by pressing the tilde key `~` which is usually on the top left of the keyboard next to the number 1 key on the top row.
+   * You can access the console by pressing the tilde key "`~`" which is usually on the top left of the keyboard next to the number 1 key on the top row.
 * Now Star Citizen is configured to respond to the commands sent from Ecka.
 
 

diff --git a/docs/source/user-guide/requirements.rst b/docs/source/user-guide/requirements.rst
@@ -0,0 +1,12 @@
+Requirements
+============
+
+The requirements to run Ecka are;
+
+* 210MB of hard drive space
+* `Microsoft .NET Framework 4.7.2 Runtime <https://dotnet.microsoft.com/download/thank-you/net47>`_
+* `.NET Core 2.2 Runtime <https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.5-windows-hosting-bundle-installer>`_
+* Windows 10
+* `Star Citizen <https://robertsspaceindustries.com/star-citizen>`_ (Ecka has been fully tested with Star Citizen ALPHA 3.5)
+
+