Update the README with an introduction

This commit is contained in:
Antony Male 2014-05-27 12:53:17 +01:00
parent ff2ca4deb2
commit 0e43decb94
1 changed files with 19 additions and 10 deletions

View File

@ -4,7 +4,24 @@ StyletIoC
Introduction
------------
Blah blah
Stylet is a small but powerful ViewModel-first MVVM framework for WPF, which allows you to write maintainable and extensible code in a way which is easy to test.
Stylet's aims to:
- Solve the blockers, niggles, and annoyances which hamper MVVM development without a framework using simple but powerful concepts.
- Be obvious to people picking up your project for the first time: there's very little magic
- Be easy to verify/validate. The LOC count is low, and it comes with a very comprehensive test suite. The code is well-written and well-documented.
- Be flexible while providing sensible defaults. Almost any part of the framework can be overridden if you wish, but you probably won't want to.
It is inspired by [Caliburn.Micro](http://www.caliburnproject.org/), and shares many of its concepts, but removes most of the magic (replacing it with more powerful alternatives), and simplifies parts considerably by targeting only MVVM, WPF and .NET 4.5.
Documentation
-------------
[The wiki is the official documentation source](https://github.com/canton7/Stylet/wiki).
There's a lot of documentation there (it was longer than my dissertation last time I checked), and it's being added to all the time.
Go check it out!
Installation
@ -41,17 +58,9 @@ I maintain a subtree split of just the Stylet project, [called Stylet-Core](http
Head over there, clone/download the repo, and add the .csproj to your solution.
Documentation
-------------
[The wiki is the official documentation source](https://github.com/canton7/Stylet/wiki).
There's a lot of documentation there (it was longer than my dissertation last time I checked), and it's being added to all the time.
Go check it out!
Contributing
------------
Contributions are always welcome.
If you've got a problem or a question, [raise an issue](https://github.com/canton7/Stylet/issues).
If you've got code you want to contribute, create a feature branch off the `develop` branch, add your changes there, and submit it as a pull request.
If you've got code you want to contribute, create a feature branch off the `develop` branch, add your changes there, and submit it as a pull request.