Skip to content

Commit

Permalink
Merge pull request #113 from cartermp/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
BethMassi committed Nov 12, 2015
2 parents fcd6bd1 + 57ff34a commit 8528590
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ If you wish to add a code sample:

1. Your sample **must be part of a buildable project**
2. Your sample **cannot be a Visual Studio Project**

- We do not want Windows and Visual Studio to be a dependency for people building these on their own.
3. Your sample shoud conform to the [corefx coding style](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md) to maintain consistency.
- Additionally, we prefer the use of `static` methods rather than instance methods when demonstrating something that doesn't require instantiating a new object.

We will eventually have a CI system in place to build these projects.

Expand All @@ -17,7 +18,7 @@ To create a sample:
2. For each set of samples that demonstrates a concept, add a project.json with your dependencies and target coreclr:

```javascript
{
{
"dependencies": {
"System.Runtime":"4.0.0-rc1-*",
"System.Linq":"4.0.0-rc1-*",
Expand All @@ -36,9 +37,10 @@ To create a sample:
{
public void Main(string[] args)
{
var sample = new WhereClause1();
sample.QuerySyntaxExample();
sample.MethodSyntaxExample();
WhereClause1.QuerySyntaxExample();

// Add the method syntax as an example.
WhereClause1.MethodSyntaxExample();
}
}
```
Expand All @@ -48,8 +50,8 @@ To create a sample:

```
dnvm upgrade latest -r coreclr -u
```
6. Go to the sample folder and Build to check for errors.
```
6. Go to the sample folder and Build to check for errors.

```
dnu build
Expand All @@ -58,4 +60,4 @@ To create a sample:

```
dnx run
```
```

0 comments on commit 8528590

Please sign in to comment.