Skip to content

Commit

Permalink
Added dev guide and user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamJamesNaylor committed Jan 26, 2019
1 parent 6bc6a26 commit c9313f5
Show file tree
Hide file tree
Showing 90 changed files with 18,470 additions and 14 deletions.
3 changes: 3 additions & 0 deletions docs/source/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}"
}
4 changes: 4 additions & 0 deletions docs/source/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 06bc480b307dc66649e1e1540caf9099
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file added docs/source/_build/html/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
43 changes: 43 additions & 0 deletions docs/source/_build/html/_sources/dev-guide/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
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 fully configure.

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/flows/index
user-guide/flows/triggers
user-guide/flows/steps
user-guide/plugins/index
user-guide/plugins/installing
user-guide/ui/index
user-guide/ui/installing
user-guide/star-citizen/index

.. toctree::
:maxdepth: 1
:caption: Developer guide:

dev-guide/api-ref
dev-guide/plugins/developing
dev-guide/ui/developing





.. Indices and tables
.. ==================
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
40 changes: 40 additions & 0 deletions docs/source/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
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.

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/troubleshooting
user-guide/flows/index
user-guide/flows/triggers
user-guide/flows/steps
user-guide/plugins/index
user-guide/plugins/installing
user-guide/ui/index
user-guide/ui/installing
user-guide/star-citizen/index

.. toctree::
:maxdepth: 1
:caption: Developer guide

dev-guide/api-ref
dev-guide/plugins/developing
dev-guide/ui/developing

.. Indices and tables
.. ==================
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
24 changes: 24 additions & 0 deletions docs/source/_build/html/_sources/user-guide/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Ecka
====

Ecka is a cross platform automation application that runs locally on one or more of your device.
Ecka allows you to create flows that contain configurable steps which run in response to one or more triggers.

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: 2
:caption: User guide:

user-guide/quick-start



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
22 changes: 22 additions & 0 deletions docs/source/_build/html/_sources/user-guide/installing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Installing Ecka
===============

You can download the latest stable version of Ecka from the `download page <https://ecka.imbick.com/download>`_ or the direct link https://ecka.imbick.com/download/ecka

Once downloaded extract the ``ecka`` folder to anywhere on your computer. We recommend `7-Zip <https://www.7-zip.org/>`_.
Inside this folder you'll find an executable named ``ecka.exe`` that will launch the application when double clicked.

.. toctree::
:maxdepth: 1
:caption: User guide:

user-guide/quick-start



.. Indices and tables
.. ------------------
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
24 changes: 24 additions & 0 deletions docs/source/_build/html/_sources/user-guide/quick-start.1.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Quick start
===========

Ecka is a cross platform automation application that runs locally on one or more of your device.
Ecka allows you to create flows that contain configurable steps which run in response to one or more triggers.

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



.. Indices and tables
.. ------------------
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
24 changes: 24 additions & 0 deletions docs/source/_build/html/_sources/user-guide/quick-start.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Quick start
===========

Ecka is a cross platform automation application that runs locally on one or more of your device.
Ecka allows you to create flows that contain configurable steps which run in response to one or more triggers.

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



.. Indices and tables
.. ------------------
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
Binary file added docs/source/_build/html/_static/ajax-loader.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c9313f5

Please sign in to comment.