Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a developers guide to the README #151

Merged
merged 2 commits into from
May 10, 2022
Merged

Add a developers guide to the README #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad91245
Add a developers guide to the README
KasperJSdeVries May 9, 2022
94a8637
Update README.md
josesimoes May 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ Is part of .NET **nanoFramework** toolbox, along with other various tools that a
Version 2.0 is a C# application adapted from the original work of [Oleg Rakhmatulin](@OlegRa).
Version 1.0 was a Visual C++ application adapted from .NETMF toolbox.

## Developers guide

### Cloning the repository

After cloning the repository, instantiate the submodules with:

```shell
git submodule update --init --recursive
```

After which the NuGet packages in both the main solution and the mscorelib solution included within a submodule have to be restored. These have to be restored individually.

### Adding projects to the solution

When adding a project to the solution the following points have to be kept in mind for configuring the project and solution:

- nanoFramework projects (.nfproj) have to be build in `AnyCPU` configuration.
- DLLs for msbuild tasks have to be build in `x64` because Visual Studio uses this architecture since VS2022.
- Any nanoFramework projects (.nfproj) that are required for Unit Tests have to have theyr build configuration changed so they don't build. Building those has to be added to the pre-build event of the Unit Test project that will be using it. See the [prebuild event](https://github.com/KasperJSdeVries/metadata-processor/blob/ad91245f85dee8683670ef81c3f1f9556ecb2ac0/MetadataProcessor.Tests/MetadataProcessor.Tests.csproj#L118) for the MetadataProcessor.Tests project.

## Feedback and documentation

To provide feedback, report issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).
Expand Down