diff --git a/README.md b/README.md new file mode 100644 index 00000000..3546c151 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Nana C++ Library + +Nana is a C++ library designed to allow developers to easily create cross-platform GUI applications with modern C++11 style, currently it can work on Linux(X11) and Windows. The nana repository contains the entire source of library, you can browse the source code and submit your pull request for contributing. + +## License + +Nana is licensed under the [Boost Software License]. + +[Boost Software License]: http://www.boost.org/LICENSE_1_0.txt + +## Support + +The best way to get help with Nana library is by visiting http://nanapro.org/help.htm + +## Introduction to the Repository + +There are two main branches with an infinite lifetime: +* **master** is the main branch and it is marked as every version release. +* **develop** is also another main branch where the source code reflects a state with the lastest delivered developement changes for the next release. + +Other branches: +* **features** are used to develop new features for the upcoming or a distant future release. Feature branches are named as 'feature-FEATURENAME'. +* **hotfix** is meant to prepare for a new release, and fixes some bugs from the corresponding tag on the master branch.