Skip to content

Commit

Permalink
[.NET] Update readme with instructions for running tests and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
burkenyo authored and speth committed Aug 17, 2022
1 parent 8859643 commit 9284645
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions interfaces/dotnet/README.md
Expand Up @@ -5,7 +5,7 @@ such as C# and F#. It is written in C# and supports .NET Standard 2.0
(for the primary project) and .NET 6 (and newer) on all platforms that support both
.NET and the Cantera C++ library.

### Project Layout
## Project Layout

The primary C# project is Cantera.csproj. This project uses P/Invoke extensively with
the native Cantera library via the Cantera C interface (CLib), and wraps the low-level
Expand All @@ -23,7 +23,7 @@ The examples directory contains separate projects for each Cantera example. Thes
be packaged as a template for use with the .NET CLI, allowing developers to create a
solution with all the examples using `dotnet new`.

### Contributing
## Contributing

Like all of Cantera, we welcome contributions to the .NET interface. Contributors should
read the [code of conduct](/CODE_OF_CONDUCT.md) and check out our general and
Expand All @@ -33,8 +33,25 @@ This includes being comfortable with `unsafe` blocks and interop concepts such a
raw pointers, understanding how to use `Span<T>` and similar memory APIs, and having
a solid grip on object-oriented library design.

### Status
Discussions about contributing to the .NET interface assumes the developer has installed
the .NET SDK and is using the text editor of their choice, optionally with a plugin for
C# development installed. Visual Studio is _not_ required, and although contributors
may choose to use it, submissions should not depend on Visual Studio or require
the use of Windows.

### Running Tests

After [building the main Cantera library](https://cantera.org/install/compiling-install.html),
switch to this directory and run `dotnet test`.

### Running Examples

After running the tests, examples can be run with `dotnet run --project examples/X`,
where X is the name of the directory containing the example project, for example
`dotnet run --project examples/SoundSpeed`.

## Status

The .NET Interface is in preview and still missing many features
needed for parity with the C++ and Python interfaces. Interested contributors can see
the status of the project at [Enhancement #156](https://github.com/Cantera/enhancements/issues/156).
the status of the project at Cantera/enhancements#156.

0 comments on commit 9284645

Please sign in to comment.