diff --git a/README.md b/README.md index 285302e..71cdab9 100644 --- a/README.md +++ b/README.md @@ -17,22 +17,32 @@ # Demo +*Current release version v0.0.3 is a pre-release to test the air stability and controls. Python integration is still in development.* + +[![AirControl Basic Demo](https://img.youtube.com/vi/Lhwb4UVulMs/0.jpg)](https://www.youtube.com/watch?v=Lhwb4UVulMs) + +# Control Inputs +![Keyboard Mappings](docs/images/keyboard-layout.png) # Getting started -1. Windows +1. Windows - Not Tested 1. Download Binaries - https://github.com/snlpatel001213/AirControl/releases 2. Build it -2. Linux +2. Linux - Tested 1. Download Binaries - https://github.com/snlpatel001213/AirControl/releases 2. Build it -3. macOS +3. macOS - Not Tested 1. Download Binaries - https://github.com/snlpatel001213/AirControl/releases 2. Build it # Documentation 1. API Documentation - https://snlpatel001213.github.io/AirControl/html/index.html -2. Usage Documentation - +2. Usage Documentation - Yet ot be compiled + +# Release Goals + +Refer to the Project page for the future release, features and bug tracking : https://github.com/snlpatel001213/AirControl/projects/1 # Research Inspirations Feel free to list your research topic you love to work on over here. Collaborate and publish. diff --git a/docs/how_to.md b/docs/how_to.md index ae82685..1bc6fb6 100644 --- a/docs/how_to.md +++ b/docs/how_to.md @@ -9,3 +9,5 @@ https://snlpatel001213.github.io/AirControl/html/namespaceAirControl.html pip install sphinx sphinx-quickstart sphinx-quickstart + +http://www.keyboard-layout-editor.com/##@@=Esc&_x:1%3B&=F1&=F2&=F3&=F4&_x:0.5%3B&=F5&=F6&=F7&=F8&_x:0.5%3B&=F9&=F10&=F11&=F12&_x:0.25%3B&=PrtSc&=Scroll%20Lock&=Pause%0ABreak%3B&@_y:0.5%3B&=~%0A%60&=!%0A1&=%2F@%0A2&=%23%0A3&=$%0A4&=%25%0A5&=%5E%0A6&=%2F&%0A7&=*%0A8&=(%0A9&=)%0A0&=%2F_%0A-&=+%0A%2F=&_w:2%3B&=Backspace&_x:0.25%3B&=Insert&=Home&=PgUp&_x:0.25%3B&=Num%20Lock&=%2F%2F&=*&=-%3B&@_w:1.5%3B&=Tab&=Q&_c=%236d60e0%3B&=W%0APitch&_c=%23cccccc%3B&=E&=R&=T&=Y&=U&=I&_c=%237ccc3d%3B&=O%0ACut%20Engine&_c=%23cccccc%3B&=P&=%7B%0A%5B&=%7D%0A%5D&_w:1.5%3B&=%7C%0A%5C&_x:0.25%3B&=Delete&=End&=PgDn&_x:0.25%3B&=7%0AHome&=8%0A↑&=9%0APgUp&_h:2%3B&=+%3B&@_w:1.75%3B&=Caps%20Lock&_c=%23d9d11e%3B&=A%0ARoll&_c=%236d60e0%3B&=S%0APitch&_c=%23d9d11e%3B&=D%0ARoll&_c=%2311cfac%3B&=F%0AFlaps%20Up&=G%0AFlaps%20Down&_c=%23cccccc%3B&=H&=J&=K&=L&=%2F:%0A%2F%3B&="%0A'&_w:2.25%3B&=Enter&_x:3.5%3B&=4%0A←&=5&=6%0A→%3B&@_w:2.25%3B&=Shift&=Z&=X&_c=%23d18202%3B&=C%0ASwitch%20Camera&_c=%23cccccc%3B&=V&=B&=N&=M&=<%0A,&=>%0A.&=%3F%0A%2F%2F&_w:2.75%3B&=Shift&_x:1.25&c=%23de1212%3B&=↑%0AThrottle&_x:1.25&c=%23cccccc%3B&=1%0AEnd&=2%0A↓&=3%0APgDn&_h:2%3B&=Enter%3B&@_w:1.25%3B&=Ctrl&_w:1.25%3B&=Win&_w:1.25%3B&=Alt&_c=%2384f0a4&a:5&w:6.25%3B&=%0ABrake&_c=%23cccccc&a:4&w:1.25%3B&=Alt&_w:1.25%3B&=Win&_w:1.25%3B&=Menu&_w:1.25%3B&=Ctrl&_x:0.25&c=%231cbaad&t=%230e0f0f%3B&=←%0AYaw&_c=%23d43737&t=%23000000&p=Throttle%3B&=↓%0AThrottle&_c=%231cbaad&p=%3B&=→%0AYaw&_x:0.25&c=%23cccccc&w:2%3B&=0%0AIns&=.%0ADel \ No newline at end of file diff --git a/docs/images/keyboard-layout.png b/docs/images/keyboard-layout.png new file mode 100644 index 0000000..900a2e9 Binary files /dev/null and b/docs/images/keyboard-layout.png differ