From 7caef13b291243a40bb523a642da2b893453b153 Mon Sep 17 00:00:00 2001 From: Charles Cowart Date: Wed, 6 Jul 2022 15:12:11 -0700 Subject: [PATCH 1/2] Fix README.md Update README.md for readability in GitHub, clarity. --- README.md | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5913aaa..ab667e8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,30 @@ -# microsetta-adminname: microsetta-admin CI +# microsetta-admin +An admin interface to support The Microsetta Initiative -conda create --name test-microsetta-admin python=3.7 -conda activate test-microsetta-admin -conda install --yes --file ci/conda_requirements.txt -pip install -r ci/pip_requirements.txt -make install -conda activate test-microsetta-admin +## Installation -before make test, add: -conda install -c conda-forge nodejs +Other projects should be installed first. -make test +Create a new `conda` environment containing `flask` and other necessary packages: +`conda create --name test-microsetta-admin python=3.7` + +Once the conda environment is created, activate it: +`conda activate test-microsetta-admin` + +Ensure that the `conda-forge` channel has been added to the conda install and run: +`conda install --yes --file ci/conda_requirements.txt` + +Install additional requirements using pip: +`pip install -r ci/pip_requirements.txt` + +Install vi 'make' command and 'Makefile'. +`make install` + +Reactivate environment after install: +`conda activate test-microsetta-admin` + +Lastly, add nodejs. +`conda install -c conda-forge nodejs` + +To run unittests: +`make test` From ccc37f52a0bef33ae7e5733aff362b43e3c6db56 Mon Sep 17 00:00:00 2001 From: Charles Cowart Date: Wed, 6 Jul 2022 18:41:07 -0700 Subject: [PATCH 2/2] Updated README.md Updated README.md for clarity. --- README.md | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ab667e8..77d655e 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,41 @@ An admin interface to support The Microsetta Initiative ## Installation - -Other projects should be installed first. +Other projects should be installed first.
+https://github.com/biocore/microsetta-interface.git
+https://github.com/charles-cowart/microsetta-private-api.git Create a new `conda` environment containing `flask` and other necessary packages: -`conda create --name test-microsetta-admin python=3.7` +``` +conda create --name test-microsetta-admin python=3.7 +``` Once the conda environment is created, activate it: -`conda activate test-microsetta-admin` +``` +conda activate test-microsetta-admin +``` Ensure that the `conda-forge` channel has been added to the conda install and run: -`conda install --yes --file ci/conda_requirements.txt` +``` +conda install --yes --file ci/conda_requirements.txt +``` Install additional requirements using pip: -`pip install -r ci/pip_requirements.txt` +``` +pip install -r ci/pip_requirements.txt +``` Install vi 'make' command and 'Makefile'. -`make install` - -Reactivate environment after install: -`conda activate test-microsetta-admin` +``` +make install +``` Lastly, add nodejs. -`conda install -c conda-forge nodejs` +``` +conda install -c conda-forge nodejs +``` To run unittests: -`make test` +``` +make test +```