pixi docs

Author: mpatrou

README.md

@@ -17,24 +17,21 @@ histogram data object
 2. Go to a location where you would like to install histogram, run:
 
    ```bash
-   git clone https://github.com/neutrons/histogram-dev.git`
+   git clone https://github.com/neutrons/histogram-dev.git
 
    ```
 
-3. Setup/Update the environment
+3. Setup-activate and enter the environment
 
     ```bash
-    pixi install
+    pixi shell
     ```
 
 The histogram environment is activated and the application is ready to use.
 
 
 ## For Contributors
 
-**Development/Deployment**
-
----
 
 * Pixi additional Information
 
@@ -46,10 +43,10 @@ The histogram environment is activated and the application is ready to use.
 
   ```
 
-  to enter the environment
+  to install/update the enrivornment
 
     ```bash
-    pixi shell
+    pixi install
 
     ```
 

docs/sphinx/install-details.rst

@@ -17,20 +17,3 @@ Optionally, you may want to install:
 
 * `h5py <http://code.google.com/p/h5py/>`_: for load/dump histograms
 * `matplotlib <http://matplotlib.sourceforge.net/>`_: for plotting
-
-
-Install
--------
-The histogram package can be installed by using pip install in editable mode currently::
-
- $ git clone git@github.com:neutrons/histogram-dev.git.
-
-Navigate to the root directory of histogram-dev:::
-
- $ conda env create
-
- (This will create an environment using the environment.yml file.)
-
-To install the package, in the correct environment(histogram-dev)::
-
- $ pip install -e .

docs/sphinx/install.rst

@@ -3,43 +3,38 @@
 Installation
 ============
 
-The histogram package can be installed:
+The histogram package can be installed with 2 ways:
 
-    1. from the source code:
+* from the source code:
 
-        1. Install [Pixi](https://pixi.sh/) for managing environments, dependencies, packaging, and task execution. (if it is not already installed).
+    1. Install `Pixi <https://pixi.sh/>`_ for managing environments, dependencies, packaging, and task execution. (if it is not already installed).
 
         Pixi installation e.g. for Linux:
 
-        ```bash
+        .. code:: shell
 
-        curl -fsSL https://pixi.sh/install.sh | sh
+            $ curl -fsSL https://pixi.sh/install.sh | sh
 
-        ```
-        Also install git, if it is missing.
 
-        2. Go to a location where you would like to install the program (e.g., $HOME/software), run:
+        Also install git, if it is missing.
 
+    2. Go to a location where you would like to install the program, run:
 
-            `git clone https://github.com/neutrons/histogram-dev.git`
+        .. code:: shell
 
-        3. Setup/Update the environment
+            $ git clone https://github.com/neutrons/histogram-dev.git
 
-        ```bash
-        pixi install
-        ```
+    3. Setup and enter the environment
 
-        or to enter the environment
+        .. code:: shell
 
-        ```bash
-        pixi shell
+            $ pixi shell
 
-        ```
-    2. as a conda package: https://anaconda.org/neutrons/histogram
+* as a conda package: `Histogram Package Installation Instructions <https://anaconda.org/neutrons/histogram>`_
 
 
  To test, in the root directory type:
 
  pytest
 
-:ref:`More details <install-details>`
+:ref:`Additional details <install-details>`