diff options
author | Jakob Odersky <jodersky@gmail.com> | 2015-03-18 23:09:25 +0100 |
---|---|---|
committer | Jakob Odersky <jodersky@gmail.com> | 2015-03-18 23:09:59 +0100 |
commit | 99e93734d846f24f2107482869fac58c9dff1774 (patch) | |
tree | 2e08670c1cec8209095cc4c6032dafa35d43c133 /README.md | |
parent | 069120ac286dd35f8693d21bfa3cf617da454521 (diff) | |
download | mavigator-99e93734d846f24f2107482869fac58c9dff1774.tar.gz mavigator-99e93734d846f24f2107482869fac58c9dff1774.tar.bz2 mavigator-99e93734d846f24f2107482869fac58c9dff1774.zip |
Add documentation on how to run application
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 23 |
1 files changed, 13 insertions, 10 deletions
@@ -8,16 +8,19 @@ This project is made of several subprojects: - `vfd-uav` communication backend for message exchange with drones # Run - 0. SBT is used as the build tool. - - 1. Switch to project `vfd-main` and then `run`. *Note: if this is the first time your run a play project throught sbt, be aware that you may need to wait a while as your computer downloads half the internet* - - project vfd-main - run - - Calling `vfd-main/run` directly will not work. - - 2. Navigate to localhost:9000 in a modern browser (tested on Firefox and Chrome) to see the interface. The feed defaults to mock data. +SBT is used as the build tool. However, the standard 'sbt run' procedure does not work as there seems +to be some problems with plugins used. +Hence, the general workflow is as follows: + + 1. start sbt in the base directory + 2. enter 'project vfd-main' + 3. enter 'run' + *Note: if this is the first time your run a play project throught sbt, be aware that you may need to wait a while as your computer downloads half the internet* + 4. open localhost:9000 in a modern browser to see the application in action + 5. make some changes + 6. go to step 4 (the application is automatically recompiled) + +Currently, standalone deployment and packaging of the application is not is broken. # Developer Overview The general idea of this project is to create a web interface for displaying live data from a drone. |