Skip to content

Commit b1b7ceb

Browse files
committed
adjusting doc
1 parent c7895fe commit b1b7ceb

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
-----
77

8-
### Welcome to the **nanoFramework** Base Class Library repository!
8+
# Welcome to the **nanoFramework** Base Class Library repository!
99

1010
## Build status
1111

@@ -20,6 +20,23 @@
2020

2121
The **nanoFramework** Base Class Library is provided in two flavours: with or without support for System.Reflection namespace. The reason for this is that the reflection API adds up a significant size to the DLL and image size. For targets with smaller flash this can be prohibitive.
2222

23+
## Unit Test
24+
25+
nanoFramework has a dedicated [Unit Test framework](https://github.com/nanoframework/nanoFramework.TestFramework). This repository has Unit Test and you will find all of them under the `Tests`folder. The main solution embed all all the tests as well. You can run them directly from Visual Studio and create new tests. For more information on the [Unit Test Framework](https://docs.nanoframework.net/content/unit-test/index.html).
26+
27+
lib-CoreLibrary has specific needs that differ from what you'll find in the documentation:
28+
29+
- You need to have th nanoFramework.TestFramework as a nuget package as it will bring the nanoCLR Win32 emulator
30+
- You need to remove the reference to mscorlib, nanoFramework.TestFramework and nanoFramework.UnitTestLauncher
31+
- Use project reference instead for all those 3 elements
32+
33+
You can then run the test either on a real device, either in the emulator as described in the documentation. You may have to manually flash your device for the mscorlib version to match the one you are building on.
34+
35+
**Important**: Any new code checked in this repository will have to:
36+
37+
- have a proper test covering for all the methods, properties, events and the possible exceptions,
38+
- do not break more of the the existing tests meaning, in other words, it should not create more issues than already existing.
39+
2340
## Feedback and documentation
2441

2542
For documentation, providing feedback, issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).

0 commit comments

Comments
 (0)