Deploying to docs-publish-github-page from @ 4d6047e 🚀

_sources/basics.rst.txt

@@ -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.

_sources/index.rst.txt

@@ -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

_sources/installation.rst.txt

@@ -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

_sources/about.rst.txt → _sources/overview.rst.txt

@@ -1,5 +1,5 @@
 ======================================================
-[|:construction:| WIP |:construction:|] About
+[|:construction:| WIP |:construction:|] Overview
 ======================================================
 
-About page.
+Overview page.

_sources/sdk.rst.txt

@@ -2,4 +2,11 @@
 [|:construction:| WIP |:construction:|] SDK
 ===========================================
 
-SDK documentation page.
+SDK documentation page.
+
+Upgrading
+----------------------------------
+
+.. code-block:: sh
+
+   emf-cli upgrade

how-to-get-started.html → basics.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>[🚧 WIP 🚧] How to get started? &mdash; Easy Model Fusion tbd documentation</title>
+  <title>[🚧 WIP 🚧] Basics &mdash; Easy Model Fusion tbd documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -19,11 +19,10 @@
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
-    <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="[🚧 WIP 🚧] Examples" href="examples.html" />
-    <link rel="prev" title="[🚧 WIP 🚧] How does it work?" href="how-does-it-work.html" /> 
+    <link rel="prev" title="Installation" href="installation.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -47,9 +46,12 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="about.html">[🚧 WIP 🚧] About</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-does-it-work.html">[🚧 WIP 🚧] How does it work?</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">[🚧 WIP 🚧] How to get started?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">[🚧 WIP 🚧] Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">[🚧 WIP 🚧] Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#create-your-first-project">Create your first project</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">[🚧 WIP 🚧] Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="emf-cli.html">[🚧 WIP 🚧] EMF Command Line Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sdk.html">[🚧 WIP 🚧] SDK</a></li>
@@ -70,26 +72,35 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">[🚧 WIP 🚧] How to get started?</li>
+      <li class="breadcrumb-item active">[🚧 WIP 🚧] Basics</li>
       <li class="wy-breadcrumbs-aside">
-            <a href="_sources/how-to-get-started.rst.txt" rel="nofollow"> View page source</a>
+            <a href="_sources/basics.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="construction-wip-construction-how-to-get-started">
-<h1>[🚧 WIP 🚧] How to get started?<a class="headerlink" href="#construction-wip-construction-how-to-get-started" title="Permalink to this heading"></a></h1>
-<p>How to get started page.</p>
+  <section id="construction-wip-construction-basics">
+<h1>[🚧 WIP 🚧] Basics<a class="headerlink" href="#construction-wip-construction-basics" title="Permalink to this heading"></a></h1>
+<p>Basics page.</p>
+<section id="create-your-first-project">
+<h2>Create your first project<a class="headerlink" href="#create-your-first-project" title="Permalink to this heading"></a></h2>
+<p>Type in the following command to create your first project</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>emf-cli<span class="w"> </span>init<span class="w"> </span>awesome-ia-app
+</pre></div>
+</div>
+<p><strong>Congratulations on creating your first project!</strong> 👏</p>
+<p>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.</p>
+</section>
 </section>
 
 
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="how-does-it-work.html" class="btn btn-neutral float-left" title="[🚧 WIP 🚧] How does it work?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="examples.html" class="btn btn-neutral float-right" title="[🚧 WIP 🚧] Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

contributing.html

@@ -19,7 +19,6 @@
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
-    <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="prev" title="[🚧 WIP 🚧] SDK" href="sdk.html" /> 
@@ -46,9 +45,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="about.html">[🚧 WIP 🚧] About</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-does-it-work.html">[🚧 WIP 🚧] How does it work?</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-to-get-started.html">[🚧 WIP 🚧] How to get started?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">[🚧 WIP 🚧] Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="basics.html">[🚧 WIP 🚧] Basics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">[🚧 WIP 🚧] Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="emf-cli.html">[🚧 WIP 🚧] EMF Command Line Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sdk.html">[🚧 WIP 🚧] SDK</a></li>

emf-cli.html

@@ -19,7 +19,6 @@
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
-    <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="[🚧 WIP 🚧] SDK" href="sdk.html" />
@@ -47,9 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="about.html">[🚧 WIP 🚧] About</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-does-it-work.html">[🚧 WIP 🚧] How does it work?</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-to-get-started.html">[🚧 WIP 🚧] How to get started?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">[🚧 WIP 🚧] Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="basics.html">[🚧 WIP 🚧] Basics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">[🚧 WIP 🚧] Examples</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">[🚧 WIP 🚧] EMF Command Line Interface</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#titre-de-niveau-2">Titre de niveau 2</a><ul>

examples.html

@@ -19,11 +19,10 @@
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
-    <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="[🚧 WIP 🚧] EMF Command Line Interface" href="emf-cli.html" />
-    <link rel="prev" title="[🚧 WIP 🚧] How to get started?" href="how-to-get-started.html" /> 
+    <link rel="prev" title="[🚧 WIP 🚧] Basics" href="basics.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -47,9 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="about.html">[🚧 WIP 🚧] About</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-does-it-work.html">[🚧 WIP 🚧] How does it work?</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-to-get-started.html">[🚧 WIP 🚧] How to get started?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">[🚧 WIP 🚧] Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="basics.html">[🚧 WIP 🚧] Basics</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">[🚧 WIP 🚧] Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="emf-cli.html">[🚧 WIP 🚧] EMF Command Line Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sdk.html">[🚧 WIP 🚧] SDK</a></li>
@@ -89,7 +88,7 @@ <h1>[🚧 WIP 🚧] Examples<a class="headerlink" href="#construction-wip-constr
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="how-to-get-started.html" class="btn btn-neutral float-left" title="[🚧 WIP 🚧] How to get started?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="basics.html" class="btn btn-neutral float-left" title="[🚧 WIP 🚧] Basics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="emf-cli.html" class="btn btn-neutral float-right" title="[🚧 WIP 🚧] EMF Command Line Interface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

genindex.html

@@ -18,7 +18,6 @@
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
-    <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" /> 
 </head>
@@ -44,9 +43,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="about.html">[🚧 WIP 🚧] About</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-does-it-work.html">[🚧 WIP 🚧] How does it work?</a></li>
-<li class="toctree-l1"><a class="reference internal" href="how-to-get-started.html">[🚧 WIP 🚧] How to get started?</a></li>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">[🚧 WIP 🚧] Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="basics.html">[🚧 WIP 🚧] Basics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">[🚧 WIP 🚧] Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="emf-cli.html">[🚧 WIP 🚧] EMF Command Line Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sdk.html">[🚧 WIP 🚧] SDK</a></li>