From 83d225b3db75cf1202c7fdc0d1e90199fc2822e7 Mon Sep 17 00:00:00 2001 From: Rares Gaia Date: Thu, 15 Aug 2024 10:42:50 +0300 Subject: [PATCH] docs: installation doc added installation doc with steps to install mutliworld and apply patch --- docs/source/sections/installation.rst | 41 ++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/source/sections/installation.rst b/docs/source/sections/installation.rst index 50e3447..1c52c4d 100644 --- a/docs/source/sections/installation.rst +++ b/docs/source/sections/installation.rst @@ -4,5 +4,44 @@ **Installation** ================ +`multiworld` can be installed in a few different ways depending on your needs. Below are instructions for installing it via PyPI and directly from the source. - \ No newline at end of file +Installing from PyPI +-------------------- +The easiest way to get started with `multiworld` is by installing it from the Python Package Index (PyPI). This method ensures you get the latest stable release. + +To install, simply run: + +.. code-block:: bash + + pip install multiworld + +This command will download and install the latest version of `multiworld` and all of its dependencies. + +Installing from Source +---------------------- +If you prefer to work with the latest development version or want to contribute to the project, you can clone the repository and install it manually. + +First, clone the repository from GitHub: + +.. code-block:: bash + + git clone https://github.com/cisco-open/pymultiworld.git + +Then, navigate to the cloned directory and install the package: + +.. code-block:: bash + + cd pymultiworld + pip install . + +This method allows you to modify the source code or contribute back to the project. + +Run post installation script +---------------------------- + +After installation, run the `m8d-post-setup` script: + +.. code-block:: bash + + m8d-post-setup