aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4316d2f..cb5f397 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,19 @@
# Virtual Flight Deck for UAVs
-This project is in its making...
+Web interface simulating a cockpit of an unmanned aerial vehicle, built with Akka and Play.
+
+This project is made of several subprojects:
+ - `vfd-backend` contains the play application that runs the actual interface
+ - `vfd-frontend` dynamic interface built with scalajs that is served by `vfd-backend`
+ - `vfd-uav` library for communicating with UAVs
+
+# Run
+First, switch to project `vfd-backend` and then `run`
+
+ project vfd-backend
+ run
+
+Calling `vfd-backend/run` directly will not work.
# License
Copyright (C) Jakob Odersky