Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 2.31 KB

HACKING.md

File metadata and controls

43 lines (23 loc) · 2.31 KB

This project uses different type of microcontrollers:

On the software side, you need to be familiar with Git, the ARM GCC toolchain, GNU Make, OpenOCD and the ST-Link programmer.

If you are on Windows it may be easier to compile the software with Git Bash shell.

The web interface and associated dev tools are built in JavaScript using Node.js, Webpack and the Material Design Lite framework.

IMPORTANT This project makes use of Git submodules. Please clone it by running:

git clone --recursive https://github.com/laneboysrc/rc-headless-transmitter.git

Alternatively, run the following commands in the project root:

git submodule init
git submodule update

GH-PAGES

We can host the web-app via Github pages conveniently. Since it is served via HTTPS we can use ServiceWorker and other goodies.

Setup

In the root of the project, execute

git clone https://github.com/laneboysrc/rc-headless-transmitter.git --branch gh-pages --single-branch gh-pages

This creates a folder named gh-pages with the web-app source code, cloned from the current state of the rc-headless-transmitter's gh-pages branch. Note that the gh-pages is in .gitignore of the master branch, so it does not appear in the master branch.

When building the web-app (run npm run build in configurator/web-app), the files are automatically placed into the gh-pages folder.

To update the web-app on Github, go into the gh-pages folder, commit the changes, and run git push.

Source: http://stackoverflow.com/questions/1778088/how-to-clone-a-single-branch-in-git