Update documentation with information about Docker.

We-Gold · Aug 7, 2024 · 4358ebc · 4358ebc
1 parent 897b86a
commit 4358ebc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/documentation/docs/guide/downloading.md b/documentation/docs/guide/downloading.md
@@ -1,13 +1,15 @@
 # Download Ouroboros
 
-There are prebuilt applications available in [Releases](https://github.com/We-Gold/ouroboros/releases).
+[Docker](https://www.docker.com/) **is required** to run Ouroboros. Make sure to install and run it before running Ouroboros.
+
+Prebuilt applications are available in [Releases](https://github.com/We-Gold/ouroboros/releases).
 
 - Windows: `*-setup.exe`
 - Mac: `*.dmg`
 - Linux: Multiple options available
 
-When you open the app, the GUI will open immediately, but **the local server that runs the processing could take up to 15 seconds to start**. There is an indicator in the GUI that shows if the server is connected.
+When you open the app, the GUI will open immediately, but **the local server that runs the processing could take up a minute to start** the first time it is run. There is an indicator in the GUI that shows if the server is connected.
 
 Currently, none of the apps are notarized. 
 
-For Mac, if an error occurs when you try to run the app, find the app installation (should be called `ouroboros.app`) and run `xattr -d com.apple.quarantine ouroboros.app`. 
+For Mac, if an error occurs when you try to run the app, find the app installation (should be called `Ouroboros.app`) and run `xattr -d com.apple.quarantine Ouroboros.app`. 
diff --git a/documentation/docs/index.md b/documentation/docs/index.md
@@ -8,11 +8,11 @@ Extract ROIs from cloud-hosted medical scans.
 
 Ouroboros is a desktop app (built with Electron) and a Python package (with a CLI). 
 
-The desktop app comes with a pre-compiled Python server (from the Python package). It runs the server in the background to handle all processing and calculations.
+The desktop app uses Docker to build and run its Python server. For this reason, **Docker is required** to run Ouroboros.
 
 If you are interested in using the Python package for its CLI or for a custom usecase, check out the [python](https://github.com/We-Gold/ouroboros/tree/main/python) folder in the main repository.
 
-Ouroboros also supports a plugin system. A plugin usage guide is forthcoming.
+Ouroboros also has a [Plugin System](./guide/plugins.md). Plugin servers are also run in Docker.
 
 ## Usage Guide