diff options
Diffstat (limited to 'tools/build_defs/dotnet/README.md')
| -rw-r--r-- | tools/build_defs/dotnet/README.md | 269 |
1 files changed, 0 insertions, 269 deletions
diff --git a/tools/build_defs/dotnet/README.md b/tools/build_defs/dotnet/README.md deleted file mode 100644 index 36873ec411..0000000000 --- a/tools/build_defs/dotnet/README.md +++ /dev/null @@ -1,269 +0,0 @@ -# C# Rules - -## Rules - -<div class="toc"> - <h2>Rules</h2> - <ul> - <li><a href="#csharp_library">csharp_library</a></li> - <li><a href="#csharp_binary">csharp_binary</a></li> - <li><a href="#csharp_nunit_test">csharp_nunit_test</a></li> - </ul> -</div> - -## Overview - -This is a minimal viable set of C# bindings for building csharp code with -mono. It's still pretty rough but it works as a proof of concept that could -grow into something more. If windows support ever happens for Bazel then this -might become especially valuable. - -## Setup - -Add the following to your `WORKSPACE` file to add the external repositories: - -```python -load("@bazel_tools//tools/build_defs/dotnet:csharp.bzl", "csharp_repositories") - -csharp_repositories() -``` - -## Examples - -### csharp_library - -```python -csharp_library( - name = "MyLib", - srcs = ["MyLib.cs"], - deps = ["//my/dependency:SomeLib"], -) -``` - -### csharp_binary - -```python -csharp_binary( - name = "MyApp", - main = "MyApp", # optional name of the main class. - srcs = ["MyApp.cs"], - deps = ["//my/dependency:MyLib"], -) -``` - -### csharp\_nunit\_test - -```python -csharp_nunit_test( - name = "MyApp", - srcs = ["MyApp.cs"], - deps = ["//my/dependency:MyLib"], -) -``` - -## Things still missing: - -- Handle .resx files correctly. -- .Net Modules -- Conditionally building documentation. -- Pulling Mono in through a mono.WORKSPACE file. - -## Future nice to haves: - -- Building csproj and sln files for VS and MonoDevelop. -- Nuget Packaging -- Windows .NET framwork support - -<a name="csharp_library"></a> -## csharp_library - -```python -csharp_library(name, srcs, deps, warn=4, csc) -``` - -Builds a C# .NET library and its corresponding documentation. - -<table class="table table-condensed table-bordered table-params"> - <colgroup> - <col class="col-param" /> - <col class="param-description" /> - </colgroup> - <thead> - <tr> - <th colspan="2">Attributes</th> - </tr> - </thead> - <tbody> - <tr> - <td><code>name</code></td> - <td> - <p><code>Name, required</code></p> - <p>Unique name for this rule</p> - </td> - </tr> - <tr> - <td><code>srcs</code></td> - <td> - <p><code>List of Labels; required</code></p> - <p>Csharp .cs or .resx files.</p> - </td> - </tr> - <tr> - <td><code>deps</code></td> - <td> - <p><code>List of Labels; optional</code></p> - <p>Dependencies for this rule.</p> - </td> - </tr> - <tr> - <td><code>warn</code></td> - <td> - <p><code>Int; optional; default is 4</code></p> - <p>Compiler warn level for this library. (Defaults to 4.)</p> - </td> - </tr> - <tr> - <td><code>csc</code></td> - <td> - <p><code>string; optional</code></p> - <p>Override the default csharp compiler.</p> - <p> - <strong>Note:</strong> This attribute may removed in future - versions. - </p> - </td> - </tr> - </tbody> -</table> - -<a name="csharp_binary"></a> -## csharp_binary - -```python -csharp_binary(name, srcs, deps, main_class, warn=4, csc) -``` - -Builds a C# .NET binary. - -<table class="table table-condensed table-bordered table-params"> - <colgroup> - <col class="col-param" /> - <col class="param-description" /> - </colgroup> - <thead> - <tr> - <th colspan="2">Attributes</th> - </tr> - </thead> - <tbody> - <tr> - <td><code>name</code></td> - <td> - <p><code>Name, required</code></p> - <p>Unique name for this rule</p> - </td> - </tr> - <tr> - <td><code>srcs</code></td> - <td> - <p><code>List of Labels; required</code></p> - <p>Csharp .cs or .resx files.</p> - </td> - </tr> - <tr> - <td><code>deps</code></td> - <td> - <p><code>List of Labels; optional</code></p> - <p>Dependencies for this rule.</p> - </td> - </tr> - <tr> - <td><code>main_class</code></td> - <td> - <p><code>String; optional</code> - <p>Name of class with <code>main()</code> method to use as entry point.</p> - </td> - </tr> - <tr> - <td><code>warn</code></td> - <td> - <p><code>Int; optional; default is 4</code></p> - <p>Compiler warn level for this binary. (Defaults to 4.)</p> - </td> - </tr> - <tr> - <td><code>csc</code></td> - <td> - <p><code>string; optional</code></p> - <p>Override the default csharp compiler.</p> - <p> - <strong>Note:</strong> This attribute may removed in future - versions. - </p> - </td> - </tr> - </tbody> -</table> - -<a name="csharp_nunit_test"></a> -## csharp\_nunit\_test - -```python -csharp_nunit_test(name, srcs, deps, warn=4, csc) -``` - -Builds a C# .NET test binary that uses the [NUnit](http://www.nunit.org/) unit -testing framework. - -<table class="table table-condensed table-bordered table-params"> - <colgroup> - <col class="col-param" /> - <col class="param-description" /> - </colgroup> - <thead> - <tr> - <th colspan="2">Attributes</th> - </tr> - </thead> - <tbody> - <tr> - <td><code>name</code></td> - <td> - <p><code>Name, required</code></p> - <p>Unique name for this rule</p> - </td> - </tr> - <tr> - <td><code>srcs</code></td> - <td> - <p><code>List of Labels; required</code></p> - <p>Csharp .cs or .resx files.</p> - </td> - </tr> - <tr> - <td><code>deps</code></td> - <td> - <p><code>List of Labels; optional</code></p> - <p>Dependencies for this rule.</p> - </td> - </tr> - <tr> - <td><code>warn</code></td> - <td> - <p><code>Int; optional; default is 4</code></p> - <p>Compiler warn level for this test. (Defaults to 4.)</p> - </td> - </tr> - <tr> - <td><code>csc</code></td> - <td> - <p><code>string; optional</code></p> - <p>Override the default csharp compiler.</p> - <p> - <strong>Note:</strong> This attribute may removed in future - versions. - </p> - </td> - </tr> - </tbody> -</table> |