diff --git a/README.md b/README.md index 976dd98..b52aa59 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# DarkUI +## DarkUI Dark themed control and docking library for .NET WinForms. + +### About DarkUI +DarkUI is an attempt to create a simple, extensible control library which emulates the look and feel of popular tabbed document interfaces such as Visual Studio, Photoshop, WebStorm, and XCode. Originally just a collection of bug fixes and enhancements built on top of WinForms, it has now evolved in to a fully working docking and control library. + +Check out our [GitHub Pages site](http://www.darkui.com). + +### How to use +DarkUI is easy to use. It uses a mix of inherited control types (text box, button, label etc.) and a few completely custom additions (dock panel, list view, scrollbar etc.) If you've ever built a WinForms application before, you should be able to easily use DarkUI in exactly the same way. + +Simply download the latest version from GitHub and build it - the example application included shows how you can build a Visual Studio style tabbed interface within minutes. + +For more detailed information and tutorials check out the [GitHub project wiki](https://github.com/RobinPerris/DarkUI/wiki). + +### Screenshots +Game map editor + +![Game map editor](http://www.darkui.com/images/editor.png) + +Lua script editor + +![Lua script editor](http://www.darkui.com/images/lua.png) + +Example docking application + +![Example docking application](http://www.darkui.com/images/docking.png) + +Controls preview + +![Controls preview](http://www.darkui.com/images/controls.png) \ No newline at end of file