Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added Documentation (#991)
* Reminder about programming syntax correction

* Fix grammatical errors
  • Loading branch information
ChinKX authored and Keboo committed Jul 25, 2018
1 parent ad5071d commit 351ad72
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
@@ -1,24 +1,24 @@
# Contribution Guidelines

PRs to this project are welcome, but before contributing please bear in mind my thoughts below. If you want to get involved but are unsure, please ask (say hello in the [Gitter chat room](http://gitter.im/ButchersBoy/MaterialDesignInXamlToolkit)). Also note I wrote these guidelines several months after the library was first made available, with the benefit of hindsight. Apologies if there are inconsistencies with what you read below and what's already in the library.
PRs to this project are welcome, but before contributing please bear in mind my thoughts below. If you want to get involved but are unsure, please ask (say hello in the [Gitter chat room](http://gitter.im/ButchersBoy/MaterialDesignInXamlToolkit)). Also note that I wrote these guidelines several months after the library was first made available, with the benefit of hindsight. Apologies if there are inconsistencies with what you read below and what's already in the library.

## The purpose of this library:
## The purposes of this library:

This is a theme library, **not** a control library. There is a subtle difference. Yes, there are some new custom controls, but their role is to specifically support either styling of existing WPF controls, or to Material Design components, as per the "Components" section in [Google's guidelines](https://www.google.com/design/spec/material-design/introduction.html).

The role of this library is to give users Material Design themes for standard WPF controls, and custom controls for Google specified components where no parallel exists in WPF, or where existing WPF controls cannot be sufficiently styled to meet the Google specification. Anything else is outside the scope of this library. WPF is very powerful and flexible when it comes to creating custom controls, but that doesn't mean I want to fill up this library with random controls. I want to provide the base tools and controls for Material Design, giving people a springboard to create their own controls where required.
The role of this library is to give users Material Design themes for standard WPF controls, and custom controls for Google specified components where no parallel exists in WPF, or where existing WPF controls cannot be sufficiently styled to meet the Google specification. Anything else is outside the scope of this library. WPF is very powerful and flexible when it comes to creating custom controls, but that doesn't mean that I want to fill up this library with random controls. I want to provide the base tools and controls for Material Design, giving people a springboard to create their own controls where required.

In no way is this library a home for any sort of application or business logic.

## Coding standards:

I code using standard Visual Studio settings, using Resharper, and adopt (most of) ReSharper's suggestions. I'd like code to look pretty similar.
I code using standard Visual Studio settings, using Resharper, and adopt (most of the) ReSharper's suggestions. I'd like the code to look pretty similar.

The API is king. If adding anything to the public interface of this library (controls, helpers etc) be mindful of the naming and usage. Don't be offended if I accept your PR but rename things slightly.

## UWP:

This whole project is a personal hobby, and this is even more true of the UWP section. I'm not accepting any PRs to UWP as I will be coding on this in my spare time, and using it as a way to learn and explore UWP for my onw enlightenment. If and when the UWP solution becomes more mature I will relax this stance.
This whole project is a personal hobby, and this is even more true of the UWP section. I'm not accepting any PRs to UWP as I will be coding on this in my spare time, and using it as a way to learn and explore UWP for my own enlightenment. If and when the UWP solution becomes more mature I will relax this stance.

## TabControl:

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -40,7 +40,7 @@ Comprehensive and easy to use Material Design theme and control library for the
* Checkout [Motion List](https://github.com/MaterialDesignInXAML/MotionList).

# ![Alt text](web/images/MD4XAML28.png "How Can I Use The Themes?") Source Code
To load the source project you will need Visual Studio 2017. Don't worry if you have an earlier version, you can still use the compiled assemblies from NuGet (``` Install-Package MaterialDesignThemes ```). There are two demo projects in the solution, restore the NuGet packages and fire them both up. One is a "pure" Material Design project, the other illustrates how to combine with Dragablz & MahApps.
To load the source project you will need Visual Studio 2017. Don't worry if you have an earlier version, you can still use the compiled assemblies from NuGet (``` Install-Package MaterialDesignThemes ```). There are two demo projects in the solution, restore the necessary NuGet packages and correct the programming syntax that is not compatible with C# versions lower than C# 7.0 (```currently used in Visual Studio 2017```). Then, you should be able to fire both of these projects up. One is a "pure" Material Design project, the other illustrates how to combine with Dragablz & MahApps.

# ![Alt text](web/images/MD4XAML28.png "Contributions") Contribution Guidelines

Expand Down

0 comments on commit 351ad72

Please sign in to comment.