diff --git a/source/basics.rst b/source/basics.rst new file mode 100644 index 0000000..3894adf --- /dev/null +++ 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. \ No newline at end of file diff --git a/source/how-does-it-work.rst b/source/how-does-it-work.rst deleted file mode 100644 index 6f33ba0..0000000 --- a/source/how-does-it-work.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================================================ -[|:construction:| WIP |:construction:|] How does it work? -============================================================ - -How does it work page. \ No newline at end of file diff --git a/source/how-to-get-started.rst b/source/how-to-get-started.rst deleted file mode 100644 index bf6340f..0000000 --- a/source/how-to-get-started.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================================================== -[|:construction:| WIP |:construction:|] How to get started? -============================================================== - -How to get started page. \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index c4b1de5..0ae273e 100644 --- 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 new file mode 100644 index 0000000..c49c272 --- /dev/null +++ b/source/installation.rst @@ -0,0 +1,72 @@ +============================================================== +Installation +============================================================== + +.. WARNING:: + + **Python Requirements** + + EMF CLI requires `Python `_ 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 `_ . 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 `_, 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 \ No newline at end of file diff --git a/source/about.rst b/source/overview.rst similarity index 63% rename from source/about.rst rename to source/overview.rst index 61c7c0d..ebdac82 100644 --- a/source/about.rst +++ b/source/overview.rst @@ -1,5 +1,5 @@ ====================================================== -[|:construction:| WIP |:construction:|] About +[|:construction:| WIP |:construction:|] Overview ====================================================== -About page. \ No newline at end of file +Overview page. \ No newline at end of file diff --git a/source/sdk.rst b/source/sdk.rst index 47ea604..9457ec2 100644 --- a/source/sdk.rst +++ b/source/sdk.rst @@ -2,4 +2,11 @@ [|:construction:| WIP |:construction:|] SDK =========================================== -SDK documentation page. \ No newline at end of file +SDK documentation page. + +Upgrading +---------------------------------- + +.. code-block:: sh + + emf-cli upgrade \ No newline at end of file