Refined instructions for local installation setup

README.md

@@ -19,13 +19,13 @@ cd ~/
 Then create the working directory and save the path:
 ```
 export BAHMNI_DIR=$PWD/bahmni && \
-mkdir $BAHMNI_DIR
+mkdir $BAHMNI_DIR && cd $BAHMNI_DIR
 ```
 
 ### Download the Docker Compose project itself:
 
 ```
-export VERSION=2.0.0-SNAPSHOT && \
+export VERSION=2.4.0-SNAPSHOT && \
 # Download the project && \
 mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:get -DremoteRepositories=https://nexus.mekomsolutions.net/repository/maven-public -Dartifact=net.mekomsolutions:bahmni-docker-compose:$VERSION:zip -Dtransitive=false --legacy-local-repository && \
 # Unzip the project in $BAHMNI_DIR/bahmni-docker-compose-$VERSION && \
@@ -41,7 +41,7 @@ Fetch the distribution of your choice:
 Eg, Bahmni Distro **Haiti**:
 ```
 export DISTRO_GROUP="haiti" && \
-export DISTRO_VERSION="1.2.0-SNAPSHOT" && \
+export DISTRO_VERSION="2.4.0" && \
 # Download the distro && \
 mvn org.apache.maven.plugins:maven-dependency-plugin:3.2.0:get -DremoteRepositories=https://nexus.mekomsolutions.net/repository/maven-public -Dartifact=net.mekomsolutions:bahmni-distro-$DISTRO_GROUP:$DISTRO_VERSION:zip -Dtransitive=false --legacy-local-repository && \
 # Unzip the distro in $BAHMNI_DIR/bahmni-distro-$DISTRO_GROUP-$DISTRO_VERSION && \
@@ -64,18 +64,40 @@ export EIP_CONFIG_PATH=$DISTRO_PATH/eip_config
 
 The complete list of available variables can be found in [.env](.env).
 
+### Move to the location of bahmni-docker-compose project
+
+```bash
+cd $BAHMNI_DIR/bahmni-docker-compose-$VERSION
+```
+
 ### Start Bahmni:
 
+<table>
+<tr>
+<td> macOS </td> <td> Linux </td>
+</tr>
+<tr>
+<td>
+
+```bash
+docker compose -p $DISTRO_GROUP up
 ```
-cd $BAHMNI_DIR/bahmni-docker-compose-$VERSION && \
-docker-compose -p $DISTRO_GROUP up
+
+</td>
+<td>
+
+```bash
+sudo -E docker compose -p $DISTRO_GROUP up
 ```
+</td>
+</tr>
+</table>
+
 <p align="center">
 <img src="./readme/docker-compose-up-shadow.png" alt="docker-compose up" height="200">
 </p>
 
-**Important:** This assumes that you run the `docker` command as the same user and in the same window in which you exported your variables.
-If Docker is run as `sudo`, the variables won't have an effect. Make sure to either export them as root, or run `docker` with `sudo -E` option to preserve the user environment. See [Docker on Linux Post-install steps](https://docs.docker.com/engine/install/linux-postinstall/)
+**Important:** This assumes that you run the `docker` command as the same user and in the same window in which you exported your variables. On Linux we advise to run `docker` with `sudo -E` option to preserve the user environment as `su`. See [Docker on Linux Post-install steps](https://docs.docker.com/engine/install/linux-postinstall/)
 
 ### Access the servers: