#11 docs how to get started (#14)

* setup the how to get started part * creating a project * restructuring * updating main installation page * updating go install + manual install * installation build
easy-model-fusion · Mar 21, 2024 · 4d6047e · 4d6047e
1 parent 995fc46
commit 4d6047e
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 17 deletions.
diff --git a/source/basics.rst b/source/basics.rst
@@ -0,0 +1,18 @@
+============================================================
+[|:construction:| WIP |:construction:|] Basics
+============================================================
+
+Basics page.
+
+Create your first project
+----------------------------------
+
+Type in the following command to create your first project
+
+.. code-block:: shell
+
+   emf-cli init awesome-ia-app
+
+**Congratulations on creating your first project!** |:clap:|
+
+You've successfully taken your first step with the EMF toolkit. Now, it's time to dive deeper and unlock the full potential of this powerful tool.
diff --git a/source/how-does-it-work.rst b/source/how-does-it-work.rst
diff --git a/source/how-to-get-started.rst b/source/how-to-get-started.rst
diff --git a/source/index.rst b/source/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Easy Model Fusion |:hand_splayed:|
+Welcome to Easy Model Fusion |:wave:|
 ====================================================================
 
 Easy Model Fusion is an open-source solution designed to simplify and automate
@@ -15,9 +15,9 @@ environments and deploy applications across various platforms with ease |:chart_
    :maxdepth: 2
    :caption: Contents:
 
-   about.rst
-   how-does-it-work.rst
-   how-to-get-started.rst
+   overview.rst
+   installation.rst
+   basics.rst
    examples.rst
    emf-cli.rst
    sdk.rst

diff --git a/source/installation.rst b/source/installation.rst
@@ -0,0 +1,72 @@
+==============================================================
+Installation
+==============================================================
+
+.. WARNING::
+
+    **Python Requirements**
+
+    EMF CLI requires `Python <https://www.python.org/downloads>`_ version 3.10 or above. You also need to add it to the PATH.
+
+Install EMF Command Line Interface
+----------------------------------
+
+Install manually
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To download the CLI manually, go to `EMF CLI Releases <https://github.com/easy-model-fusion/emf-cli/releases>`_ . Scroll down to the Assets section of the page and click the link (.gz or .zip) for your OS and extract the files. Make sure your system Path includes the path to the EMF CLI binary you downloaded.
+
+**Note:** On macOS, if you’re not able to run commands, you may need to change the binary’s permissions to allow execution. From the binary’s folder, run: ``chmod 755 emf-cli``.
+
+Install using Go
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. NOTE::
+
+    **Go Requirements**
+
+    If you wish to install through `Go <https://go.dev/>`_, then please make sure you are using version 1.21 or above.
+
+Install it directly using the following command
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. |:construction:| This might not work since the repository is still private |:construction:|
+
+.. code-block:: shell
+
+   go install github.com/easy-model-fusion/emf-cli@latest
+
+Install it from source
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+First get the source code from the repository :
+
+.. code-block:: shell
+
+   git clone https://github.com/easy-model-fusion/emf-cli
+   cd emf-cli/
+
+Then you can start building (using make) :
+
+.. code-block:: shell
+
+   make build
+
+Or you could also build it yourself :
+
+.. code-block:: shell
+
+   go build
+
+Now all that's left for you is adding it to the PATH !
+
+Verify installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+After installation, you will have access to the ``emf-cli`` binary in your command line.
+
+You can check you have the right version with this command:
+
+.. code-block:: sh
+
+   emf-cli version
diff --git a/source/about.rst → source/overview.rst b/source/about.rst → source/overview.rst
@@ -1,5 +1,5 @@
 ======================================================
-[|:construction:| WIP |:construction:|] About
+[|:construction:| WIP |:construction:|] Overview
 ======================================================
 
-About page.
+Overview page.
diff --git a/source/sdk.rst b/source/sdk.rst
@@ -2,4 +2,11 @@
 [|:construction:| WIP |:construction:|] SDK
 ===========================================
 
-SDK documentation page.
+SDK documentation page.
+
+Upgrading
+----------------------------------
+
+.. code-block:: sh
+
+   emf-cli upgrade