Developer's Guide

To start developing on SAEDB, please follow the following instructions:

1. Fork the project to you own user name.
   • Use github's interface.
2. Clone and cd into the forked project into your workstation.
   • git clone git@github.com:your_id/saedb.git
   • cd saedb
3. Add upstream remote.
   • git remote add upstream https://github.com/THUKEG/saedb.git
4. [optional] Create a feature branch.
   • git checkout -b your_feature
5. Work on your local repo.
   • Commit your changes with git add and git commit.
6. When your work is finished, send PULL REQUEST to THUKEG/saedb.
   • Use github's interface. link
   • If upstream has been updated, please do the following before sending the pull request.
     • git fetch upstream
     • git rebase upstream/master
     • If there are any conflicts, try to resovle them.
7. Wait for other's review.
   • Use github's interface. link

Notes for Windows Developers

It's recommended to use a latest GCC compiler, such as TDM-GCC. You can then use CMake to generate MinGW Makefiles and use them to build this project.

Notes for Mac Developers

Non-xcode user

If you use emacs/vim, go ahead! To update gcc/g++, you can use macport, then install a newer gcc/g++ with port install gcc47 or similar.

xcode user

To use Xcode for development, please update to the latest Xcode(now 4.6) via Mac App Store. And xcode-sae in root directory is for you.