From 274587ed7189e4ac9606f3b8719f55349374026a Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Tue, 3 May 2022 20:53:18 -0400 Subject: [PATCH] Update readme --- README.md | 31 ++++++++++++++++++++++++++++++- conda/dev.yaml | 1 + 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df20cf0b..4a320c81 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ - +# OpenScienceLabs Web Page + +## Setup + +Create a new `conda` environment: + +```bash +$ mamba env create --file conda/dev.yaml --force +``` + +> You can use mamba or conda when creating a new environment. + + +Activate your environment: + +```bash +$ conda activate osl +``` + +Install dependencies with `poetry`: + +```bash +$ poetry install +``` + +Build and start a simple web server locally: + +```bash +$ make watch +``` diff --git a/conda/dev.yaml b/conda/dev.yaml index e0b5cd92..31c54529 100644 --- a/conda/dev.yaml +++ b/conda/dev.yaml @@ -6,3 +6,4 @@ dependencies: - python - poetry - nodejs + - make