Skip to content
This repository was archived by the owner on Jul 12, 2022. It is now read-only.

Commit 5b33f8a

Browse files
author
Immo Landwerth
committed
Add basic README.md
1 parent 0cced5a commit 5b33f8a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CodeFormatter
2+
3+
CodeFormatter is a tool that uses Roslyn to automatically rewrite the source to
4+
follow our coding styles, which are [documented here][corefx-coding-style].
5+
6+
[corefx-coding-style]: https://github.com/dotnet/corefx/wiki/Contributing#c-coding-style
7+
8+
## Usage
9+
10+
In order get the usage, simply invoke the tool with no arguments:
11+
12+
```
13+
$ .\CodeFormatter.exe
14+
CodeFormatter <solution> [<rule types>] [/file <filename>]
15+
<rule types> - Rule types to use in addition to the default ones.
16+
Use ConvertTests to convert MSTest tests to xUnit.
17+
<filename> - Only apply changes to files with specified name.
18+
```
19+
20+
## Contributing
21+
22+
We follow the same contribution process that [corefx is using][corefx-contributing].
23+
24+
[corefx-contributing]: https://github.com/dotnet/corefx/wiki/Contributing

0 commit comments

Comments
 (0)