The LCUI project is create by a China developer, and his English is not very good, so, some files will appear chinese character, please understand. thanks.

Please read the file docs/CHANGES.md, it contains IMPORTANT INFORMATION.

Read the file INSTALL for installation instructions.

See the file docs/LICENSE.TXT for the available licenses.

API reference documentation has not yet been prepared, development to more mature in this project will consider writing it. At this stage, you can refer to the header files, source code, and sample programs .

To bootstrap the build you need to run ./configure (in the root of the source tree).

In the simplest case you would run:

git clone https://github.com/lc-soft/LCUI.git
cd LCUI
git submodule update --init
./configure

Please note that if you downloaded the source code (rather than cloned via git) you likely miss the submodules and the build will therefor fail.

LCUI is built under Travis CI service. Every commit pushed to this repository will queue a build into the continuous integration service and will run sime tests to ensure that everything is going well and the project is stable. The current build status is:

Please report bugs by e-mail to lc-soft@live.cn. Don't forget to send a detailed explanation of the problem -- there is nothing worse than receiving a terse message that only says it doesn't work.

You can send pull requests via GitHub. Patches should:

1. Follow the style of the existing code.
2. One commit should do exactly one thing.
3. Commit messages should start with a summary line below 80 characters followed by a blank line, and then the reasoning/analysis for why the change was made (if appropriate).
4. Commits that fix a bug in a previous commit (which has already been merged) should start with fixup! and then the summary line of the commit it fixes. If you are writing your commit message in LCUI then type fix⇥ to get the prefix and a menu allowing you to pick the summary line from one of the last 15 commits.
5. Rebase your branch against the upstream’s master. We don’t want to pull redundant merge commits.
6. Be clear about what license applies to your patch: The files with in this repository are under the [GPL 2][] (or later) but (as the original creator) we are still allowed to create non-free derivatives. However, if patches are given to us under GPL then those cannot make it into any non-free derivatives we may later wish to create. So to make it easier for us (and avoid any legal issues) we prefer if patches are released as public domain.

Developing patches should follow this workflow:

1. Fork on GitHub (click Fork button)
2. Clone to computer: git clone git@github.com:«github account»/LCUI.git
3. cd into your repo: cd LCUI
4. Set up remote upstream: git remote add -f upstream git://github.com/lc-soft/LCUI.git

1. Create a branch for the new feature: git checkout -b my_new_feature
2. Work on your feature, add and commit as usual

Creating a branch is not strictly necessary, but it makes it easy to delete your branch when the feature has been merged into upstream, diff your branch with the version that actually ended in upstream, and to submit pull requests for multiple features (branches).

8. Push branch to GitHub: git push origin my_new_feature
9. Issue pull request: Click Pull Request button on GitHub

If a lot of changes has happened upstream you can replay your local changes on top of these, this is done with rebase, e.g.:

git fetch upstream
git rebase upstream/master

This will fetch changes and re-apply your commits on top of these.

This is generally better than merge, as it will give a clear picture of which commits are local to your branch. It will also “prune” any of your local commits if the same changes have been applied upstream.

You can use -i with rebase for an “interactive” rebase. This allows you to drop, re-arrange, merge, and reword commits, e.g.:

git rebase -i upstream/master

The LCUI Project is released under the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

Liu Chao lc-soft@live.cn

Special thanks to Liu Chao for his great work on the LCUI's development.

--- end of README.md ---