Docs update (#100)

* Added description how to install pip package on Windows (and possibly MacOS) Based on #16 (#16) * Fixes of small "typos" in the docs...
securefederatedai · Jun 4, 2021 · 28ad685 · 28ad685
1 parent e040270
commit 28ad685
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/docs/install.docker.rst b/docs/install.docker.rst
@@ -55,7 +55,7 @@ To use the latest official |productName| release, simply run:
 
 .. code-block:: console
 
-   $ docker pull openfl
+   $ docker pull intel/openfl
    
 Or if you would prefer to build an image from a specific commit or branch, run the following commands:
 

diff --git a/docs/install.initial.rst b/docs/install.initial.rst
@@ -28,9 +28,30 @@ On every node in the federation you will need to install the |productName| packa
 
 4. Install |productName| package:
 
-   .. parsed-literal::
+   **Please Note:** PyPI (pip) package is currently (May 2021) provided ONLY for Linux OS. **For installation on Windows and MacOS, please follow the manual installation from source.** 
+
+   A. **Linux** installation: 
+
+      .. parsed-literal::
+
+         $ pip install \ |productWheel|\
+   
+   B. **Windows** (and probably **MacOS**) installation:
+
+      i) Clone |productName| repository:
+
+         .. code-block:: console
+
+           $ git clone https://github.com/intel/openfl.git 
+
+      ii) Inside your python environment, call `pip install`: 
+
+         .. code-block:: console
+
+            $ cd openfl/
+            $ pip install .
+
 
-      $ pip install \ |productWheel|\
 
 5. At this point |productName| should be available within the virtual environment. To test, run the :code:`fx` command. This command is only available within this virtual environment.
 

diff --git a/docs/running_the_federation.baremetal.rst b/docs/running_the_federation.baremetal.rst
@@ -9,9 +9,9 @@ Creating the Federation
 TL;DR
 ~~~~~
 
-Here's the :download:`"Hello Federation" bash script <../tests/gitlab/test_hello_federation.sh>` used for testing the project pipeline.
+Here's the :download:`"Hello Federation" bash script <../tests/github/test_hello_federation.sh>` used for testing the project pipeline.
 
-.. literalinclude:: ../tests/gitlab/test_hello_federation.sh
+.. literalinclude:: ../tests/github/test_hello_federation.sh
   :language: bash