Skip to content

Commit e98ab95

Browse files
authored
update readme with additional install information
1 parent 15a668a commit e98ab95

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,14 @@ The setup includes the following steps
2828

2929
## Seting up the edge node (or your computer)
3030

31-
TODO: install procuedure (or alternatively: pull the docker images)
31+
CognitiveXR is built to run on GPU-accelerated edge computing hardware, such as NVIDIA Jetson devices.
32+
Our [edge-node](https://github.com/cognitivexr/edge-node) documentation gives instructions on how to build your own edge cluster.
33+
34+
If you want to run the platform on your computer you need:
35+
* Docker (for building and running the platform components)
36+
* Python (for calibrating CPOP)
37+
* A webcam (for CPOP)
38+
* (optional) An NVIDIA GPU with CUDA 11 and the [NVIDIA Docker Toolkit](https://github.com/NVIDIA/nvidia-docker)
3239

3340
## Seting up CPOP
3441

@@ -70,9 +77,16 @@ The `docker-compose.yml` contains a basic docker-compose that starts up all syst
7077
The `.env` file contains relevant parameters.
7178
The `etc/` folder contains several configuration files that are mounted into the system components.
7279

73-
#### System parameters
80+
#### Build the container images
81+
82+
We currently don't host pre-built docker images, so you will have to build them yourself:
83+
* CPOP
84+
* CogStream Mediator
85+
* CogStream Engines (e.g., fermx, and yolov5)
7486

75-
TODO: document
87+
You can find build instructions for the docker images in the respective repositories.
88+
89+
#### System parameters
7690

7791
| Variable | Description |
7892
| -------- | ----------- |
@@ -94,6 +108,8 @@ See [the CPOP documentation](https://github.com/cognitivexr/cpop#run-the-service
94108

95109
#### Start the CogStream Mediator
96110

111+
See [the CogStream documentation](https://github.com/cognitivexr/CogStream) on how to build and run the mediator.
112+
97113
## Start the HoloLens App
98114

99115
Our [Unity Demo App](https://github.com/cognitivexr/unity-demo-app/) can be built for and deployed on the HoloLens 2.

0 commit comments

Comments
 (0)