Merge pull request #9 from CEA-MetroCarac/nischal

modifying for issue 1

README.md

@@ -19,23 +19,40 @@ The collection of [functions](https://github.com/Xi-CAM/Xi-cam.CDSAXS/blob/maste
 
 
 # Installation
-`cdsaxs` is available on PyPI and can be installed using pip.
-
-```bash
-pip install cdsaxs
-```
-
-Similiarly, you can also install the latest version from the GitHub repository using pip:
-
-```bash
-pip install git+https://github.com/CEA-MetroCarac/cdsaxs.git
-```
-or clone the repository and install the package by running the following commands in the terminal:
-```bash
-git clone https://github.com/CEA-MetroCarac/cdsaxs.git
-cd cdsaxs
-pip install .
-```
+To install `cdsaxs`, it is recommended to use a virtual environment. Follow these steps:
+
+1. Create a virtual environment named `cdsaxs-venv`:
+    ```bash
+    python -m venv cdsaxs-venv
+    ```
+
+2. Activate the virtual environment:
+
+    - On Windows:
+        ```bash
+        cdsaxs-venv\Scripts\activate
+        ```
+    - On macOS and Linux:
+        ```bash
+        source cdsaxs-venv/bin/activate
+        ```
+
+3. Install `cdsaxs` from PyPI:
+    ```bash
+    pip install cdsaxs
+    ```
+
+4. Alternatively, install the latest version from the GitHub repository:
+    ```bash
+    pip install git+https://github.com/CEA-MetroCarac/cdsaxs.git
+    ```
+
+5. Or clone the repository and install the package:
+    ```bash
+    git clone https://github.com/CEA-MetroCarac/cdsaxs.git
+    cd cdsaxs
+    pip install .
+    ```
 
 # Background
 

docs/source/for_developpers.rst

@@ -189,8 +189,30 @@ Testing
 Pytest is used for testing the codebase. The tests are located in the `tests` directory and are organized by module. When adding new features or modifying existing code, 
 it is essential to write tests and check that the existing tests pass.
 
+To run the tests, you need to install the testing dependencies. You can do this by running the following command:
+
+.. code-block:: shell
+
+    (cdsaxs) $ pip install -r tests/requirements.txt
+
 To run the tests, navigate to the root directory of the project and execute the following command:
 
 .. code-block:: shell
 
-    (cdsaxs) $ pytest
+    (cdsaxs) $ pytest
+
+Modifying and building the documentation
+========================================
+
+TO build the documentation, you need to install the dependencies which are listed in the `docs/requirements.txt` file. You can install them by running the following command:
+
+.. code-block:: shell
+
+    (cdsaxs) $ pip install -r docs/requirements.txt
+
+The documentation is built using Sphinx. To modify the documentation, navigate to the `docs` directory and edit the `.rst` files. Once you have made your changes, you can build the documentation by running the following command:
+
+
+.. code-block:: shell
+
+    (cdsaxs) $ make html