diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..676f7e4fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +How to build from source? +========================= + +Both development environment and GCS are supported on Windows, Linux and Mac OS X + +The first step is to Install all OS specific prerequisites. +###Mac OS X +Install XCode and its relatated command line tools (follow Apple documentation). +Install git, curl and p7zip. You can use brew `brew install git curl p7zip` or macport: `sudo port install git curl p7zip` +###Ubuntu + + sudo apt-get install git build-essentials curl gdb wget debhelper p7zip-full unzip flex bison libsdl1.2-dev libudev-dev libusb-1.0-0-dev libc6-i386 mesa-common-dev + + +###Windows +Install [msysGIT](https://msysgit.github.io/) under `C:\git` + +Clone LibrePilot Git repository. +Open Git Bash and run + + cd /path/to/LibrePilot_root + ./make/scripts/win_sdk_install.sh + +You can build using the `/path/to/LibrePilot_root/make/winx86/bin/make` wrapper to call `mingw32-make.exe` as: + + ./make/winx86/bin/make all_sdk_install +or call `mingw32-make` directly + + mingw32-make all_sdk_install + +##Setup the build environment and build +The `all_sdk_install` target will automatically retrieve and install all needed tools (qt, arm gcc etc.) in a local folder `/path/to/LibrePilot_root/tools` + + + make all_sdk_install + make package + +The `package` target will build the complete installable package for the current platform. + +Run make with no arguments to show the complete list of supported targets. diff --git a/README.md b/README.md index 4611f09e8..e1c165a24 100644 --- a/README.md +++ b/README.md @@ -35,43 +35,3 @@ Links for the LibrePilot Project - [Issue tracker](https://librepilot.atlassian.net) - [Gitter Chat](https://gitter.im/librepilot/LibrePilot) - IRC: #LibrePilot on FreeNode - -How to build from source? -------------------------- -Both development environment and GCS are supported on Windows, Linux and Mac OS X - -The first step is to Install all OS specific prerequisites. -###Mac OS X -Install XCode and its relatated command line tools (follow Apple documentation). -Install git, curl and p7zip. You can use brew `brew install git curl p7zip` or macport: `sudo port install git curl p7zip` -###Ubuntu - - sudo apt-get install git build-essentials curl gdb wget debhelper p7zip-full unzip flex bison libsdl1.2-dev libudev-dev libusb-1.0-0-dev libc6-i386 mesa-common-dev - - -###Windows -Install [msysGIT](https://msysgit.github.io/) under `C:\git` - -Clone LibrePilot Git repository. -Open Git Bash and run - - cd /path/to/LibrePilot_root - ./make/scripts/win_sdk_install.sh - -You can build using the `/path/to/LibrePilot_root/make/winx86/bin/make` wrapper to call `mingw32-make.exe` as: - - ./make/winx86/bin/make all_sdk_install -or call `mingw32-make` directly - - mingw32-make all_sdk_install - -##Setup the build environment and build -The `all_sdk_install` target will automatically retrieve and install all needed tools (qt, arm gcc etc.) in a local folder `/path/to/LibrePilot_root/tools` - - - make all_sdk_install - make package - -The `package` target will build the complete installable package for the current platform. - -Run make with no arguments to show the complete list of supported targets. diff --git a/package/osx/package b/package/osx/package index 850e9429c..80de04875 100755 --- a/package/osx/package +++ b/package/osx/package @@ -25,7 +25,7 @@ mkdir "${SRC_DIR}/Utilities/" cp "${BUILD_DIR}/uavobject-synthetics/matlab/OPLogConvert.m" "${SRC_DIR}/Utilities/" cp "${ROOT_DIR}/WHATSNEW.txt" "${SRC_DIR}" -cp "${ROOT_DIR}/README.txt" "${SRC_DIR}/Docs/" +cp "${ROOT_DIR}/README.md" "${SRC_DIR}/Docs/README.txt" cp "${ROOT_DIR}/MILESTONES.txt" "${SRC_DIR}/Docs/" cp "${ROOT_DIR}/LICENSE.txt" "${SRC_DIR}/Docs/" cp "${ROOT_DIR}/GPLv3.txt" "${SRC_DIR}/Docs/" diff --git a/package/winx86/openpilotgcs.nsi b/package/winx86/openpilotgcs.nsi index 7c2d84058..d2b7eea22 100644 --- a/package/winx86/openpilotgcs.nsi +++ b/package/winx86/openpilotgcs.nsi @@ -168,7 +168,7 @@ Section "Core files" InSecCore File /r "${GCS_BUILD_TREE}\bin\*" SetOutPath "$INSTDIR" File "${PROJECT_ROOT}\LICENSE.txt" - File "${PROJECT_ROOT}\README.txt" + File "/oname=README.txt" "${PROJECT_ROOT}\README.md" File "${PROJECT_ROOT}\WHATSNEW.txt" File "${PROJECT_ROOT}\MILESTONES.txt" File "${PROJECT_ROOT}\GPLv3.txt"