Updated quick start guide for v1.0a

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}\\docs\\source"
+}

docs/source/api/flows/GET-trigger.rst

@@ -1,12 +1,17 @@
-Trigger flow
-============
+Trigger
+=======
+
+This operation will begin running the steps within a flow as if it was triggered. None of the triggers attached to a flow are actually involved in this operation.
 
 Requests
-========
+--------
 .. code-block:: http
 
     GET /flows/{id}/trigger HTTP/1.1
+
+Parameters
+^^^^^^^^^^
 ``{id}`` is the Guid of the flow to trigger.
 
 Response
-========
+--------

docs/source/api/flows/index.rst

@@ -0,0 +1,2 @@
+Flows
+=====

docs/source/api/service/GET-stop.rst

@@ -0,0 +1,4 @@
+Stop
+====
+
+This operation informs the Ecka application to begin shutting down.

docs/source/api/service/index.rst

@@ -0,0 +1,2 @@
+Service
+=======

docs/source/dev-guide/client-api/index.rst

@@ -0,0 +1 @@
+.. explain the api

docs/source/dev-guide/ui/index.rst

@@ -0,0 +1,2 @@
+Links inside UI files most be relative to the root (prefixed with a /) so that the correct request is made.
+They must also be prefixed with `ui` and the name of the ui, for example `/ui/example-ui/`.

docs/source/index.rst

@@ -1,19 +1,22 @@
 Ecka
 ====
 
-Ecka is a cross platform automation application that runs locally on your devices.
-Ecka allows you to create flows that when triggered run steps that you can configure.
+Ecka allows you to control Star Citizen from your touch screen devices.
 
-The core of Ecka is written in `C# <https://docs.microsoft.com/en-us/dotnet/csharp/>`_ targeting `.Net Core <https://github.com/dotnet/core>`_  2.2.
+.. 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.
 
-Ecka supports plugins so that you can extend the base feature set.
+.. The core of Ecka is written in `C# <https://docs.microsoft.com/en-us/dotnet/csharp/>`_ targeting `.Net Core <https://github.com/dotnet/core>`_  2.2.
+
+.. Ecka supports plugins so that you can extend the base feature set.
 
 .. toctree::
    :maxdepth: 1
    :caption: User guide
 
    user-guide/quick-start
-   user-guide/installing
+   .. user-guide/installing
    user-guide/troubleshooting
    user-guide/flows/index
    user-guide/flows/triggers
@@ -32,6 +35,16 @@ Ecka supports plugins so that you can extend the base feature set.
    dev-guide/plugins/developing
    dev-guide/ui/developing
 
+.. toctree::
+   :maxdepth: 2
+   :caption: API reference
+
+..   api/index
+..   api/service/index
+..   api/service/GET-stop
+..   api/flows/index
+..   api/flows/GET-trigger
+
 .. Indices and tables
 .. ==================
 .. 

docs/source/user-guide/context-menu.rst

@@ -7,6 +7,6 @@ List of menu items
 =====================
 
 * Close
-   The ``close`` item will call the :doc:`stop operation </api/service/stop>` to Ecka. Once completed the application will fully exit.
+   The ``close`` item will call the :doc:`stop operation </api/service/GET-stop>` to Ecka. Once completed the application will fully exit.
 * Flows
    Inside the ``Flows`` sub menu you will see a list of all the `flows </flows>`_ that have been added to Ecka. If the flow was successfully loaded you can click it which will call the :doc:`trigger operation </api/flows/GET-trigger>` for that flow.

docs/source/user-guide/quick-start.rst

@@ -1,26 +1,31 @@
 Quick start
 ===========
 
-Once :doc:`installed </user-guide/installing>`, you can launch Ecka from the ``ecka.exe`` in the extracted folder. This will start Ecka and place an icon in the notification area.
-
-When running you can right-click the icon to access the context menu. From here you can select commands that will interact with Ecka.
-
-Stopping Ecka
-=============
-If you want to close the Ecka application you can choose ``Close`` from the context menu. This will instruct Ecka to begin closing down.
-You can also close Ecka by using the `stop command </stop>`_ via the API.
-
-.. toctree::
-   :maxdepth: 1
-   :caption: User guide:
-
-   user-guide/quick-start
-
-
-
-.. Indices and tables
-.. ------------------
-..
-.. * :ref:`genindex`
-.. * :ref:`modindex`
-.. * :ref:`search`
+* Once `downloaded <http://ecka.imbick.com/download>`_, extract Ecka to any folder on your computer. We recommend the desktop.
+* 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.
+* 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.
+* If you have more than one connected network or adapter or multiple LAN IP addresses you must choose which one your second device will be connecting over;
+   * Choose the network adapter from the first list if more than one is available.
+   * Then choose the IP address from the second list if more than one is available.
+   * 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 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.
+* Now Star Citizen is configured to respond to the commands sent from Ecka.
+
+
+.. Once :doc:`installed </user-guide/installing>`, you can launch Ecka from the ``ecka.exe`` in the extracted folder. This will start Ecka and place an icon in the notification area.
+
+.. When running you can right-click the icon to access the context menu. From here you can select commands that will interact with Ecka.
+
+.. Stopping Ecka
+.. =============
+.. If you want to close the Ecka application you can choose ``Close`` from the context menu. This will instruct Ecka to begin closing down.
+.. You can also close Ecka by using the :doc:`stop operation </api/service/GET-stop>` via the API.