Update bower folder structure, readme and license. Closes #4

daraosn · Apr 22, 2014 · 278bc94 · 278bc94
1 parent 4a7943f
commit 278bc94
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 .DS_Store
-components
+bower_components
 node_modules
 *.js
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (C) 2013 Diego Araos <[email protected]>
+Copyright (C) 2014 Diego Araos <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/README.md b/README.md
@@ -8,17 +8,25 @@ Web interface to control the AR Drone 2.0 with an Oculus Rift. This is based on
 
 #### How to use?
 
-1. npm install
-2. bower install
-3. coffee -wc -o . .
+1. ```npm install```
+2. ```bower install```
+3. ```coffee -c -o . .```
 4. Download and run oculus-rest server (https://github.com/possan/oculus-rest)
-5. node .
-6. Go to your browser http://localhost:3000/
+5. ```node .```
+6. Go to your browser ```http://localhost:3000/```
 7. Click on the drone that appears on screen, in order to activate it.
-8. When ready press 'o' key, to activate Oculus Rift viewer
-9. To take off the drone, press 'ENTER'
-10. To land the drone, press 'ESC'
+8. When ready press 'o' key, to activate Oculus Rift viewer.
+9. Activate full screen on your browser.
+10.1. To take off the drone, press 'ENTER'
+10.2. Move your head to control the drone.
+10.3. To land the drone, press 'ESC'
 
 ##### License: MIT
 
-Disclaimer: This is just a weekend project, missed testing and code quality might not be the best, therefore I'm not resposible for any damages that this project can cause due to misusage or inexperience. If you are unsure about something please contact me at [email protected]
+Copyright (C) 2014 Diego Araos <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/component.json b/component.json
@@ -1,6 +1,6 @@
 {
-  "name": "drone-swarm",
-  "description": "Embrace the AR Drone swarm... using node.js",
+  "name": "oculus-drone",
+  "description": "Oculus Rift + AR Drone 2.0 controller",
   "version": "0.1.0",
   "dependencies": {
     "jquery": "~1.7.2",

diff --git a/index.coffee b/index.coffee
@@ -39,7 +39,7 @@ app.configure ->
   app.set('port', process.env.PORT || 3000)
   app.use(app.router)
   app.use(express.static(path.join(__dirname, 'public')))
-  app.use("/components", express.static(path.join(__dirname, 'components')))
+  app.use("/bower_components", express.static(path.join(__dirname, 'bower_components')))
 server = require("http").createServer(app)
 
 # Initialize Sockets

diff --git a/public/index.html b/public/index.html
@@ -2,10 +2,10 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <link href="/components/bootstrap/css/bootstrap.min.css" rel="stylesheet"></link>
+    <link href="/bower_components/bootstrap.css/css/bootstrap.min.css" rel="stylesheet"></link>
     <link href="/style.css" rel="stylesheet"></link>
-    <script src="/components/jquery/jquery.js"></script>
-    <script src="/components/bootstrap/js/bootstrap.min.js"></script>
+    <script src="/bower_components/jquery/jquery.js"></script>
+    <script src="/bower_components/bootstrap.css/js/bootstrap.min.js"></script>
     <script src="/jquery.colors.js"></script>
     <script src="/faye/client.js"></script>
     <script src="/drone.js"></script>