aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNavan Chauhan <navanchauhan@gmail.com>2020-09-22 17:35:32 +0530
committerNavan Chauhan <navanchauhan@gmail.com>2020-09-22 17:35:32 +0530
commit40a26591882005d1ec6948b50068408d3a0ce3d2 (patch)
treece87a52c438b07eeece7d7ce98886b69b8391051 /README.md
parent9d7455d631e9fab286b79fc2307e9934991c10c0 (diff)
updated README instructions for docker
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8151acf..23bda1d 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,25 @@ Tested on:
* macOS 10.15 (Catalina)
* Ubuntu 20.04 - Raspberry Pi 4
+# Quick Start (Docker-Compose)
+
+You can quickly get started and test Curie-Web without needing to manage dependencies by using the `docker-compose` image. This has all features except AR/3D Model support and should be production ready.
+
+
+```
+git clone https://github.com/navanchauhan/Curie-Web
+cd Curie-Web
+docker-compose up
+```
+
+Do not forget to edit `config.ini` for the email section. Do not change the database settings for running it via docker.
+
+## Caveat(s):
+
+* This does not support generating a 3D Model and thus, AR viewer will not work on the Job Status page.
+
+# Installation
+
## 1. Installing Dependencies
### 1.1 Docker