Skip to content

Commit

Permalink
docs: installation doc
Browse files Browse the repository at this point in the history
added installation doc with steps to install mutliworld and apply patch
  • Loading branch information
Rares Gaia committed Aug 15, 2024
1 parent 1f0fab9 commit 83d225b
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion docs/source/sections/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


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

0 comments on commit 83d225b

Please sign in to comment.