Skip to content

Commit da18c5a

Browse files
committed
Update readme docs
1 parent 5e8d305 commit da18c5a

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,31 @@ GitHub Actions |
3434
| FsToolkit.ErrorHandling.AsyncSeq | [![NuGet](https://buildstats.info/nuget/FsToolkit.ErrorHandling.AsyncSeq)](https://www.nuget.org/packages/FsToolkit.ErrorHandling.AsyncSeq) | [![NuGet](https://buildstats.info/nuget/FsToolkit.ErrorHandling.AsyncSeq?includePreReleases=true)](https://www.nuget.org/packages/FsToolkit.ErrorHandling.AsyncSeq/absoluteLatest)
3535
| FsToolkit.ErrorHandling.IcedTasks | [![NuGet](https://buildstats.info/nuget/FsToolkit.ErrorHandling.IcedTasks)](https://www.nuget.org/packages/FsToolkit.ErrorHandling.IcedTasks) | [![NuGet](https://buildstats.info/nuget/FsToolkit.ErrorHandling.IcedTasks?includePreReleases=true)](https://www.nuget.org/packages/FsToolkit.ErrorHandling.IcedTasks/absoluteLatest)
3636

37-
### Developing locally
3837

39-
#### Requirements
38+
39+
## Developing locally
40+
41+
### Devcontainer
42+
This repository has a devcontainer setup for VSCode. For more infomation see:
43+
- [VSCode](https://code.visualstudio.com/docs/devcontainers/containers)
44+
45+
### Local Setup
4046

4147
* [.NET Core SDK](https://www.microsoft.com/net/download/)
4248
* [v6.x](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
4349
* [v7.x](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
50+
51+
#### Optional
52+
53+
To test fable builds locally you will need:
54+
4455
* [Node](https://nodejs.org/en/)
45-
* v16.0.0 or LTS
56+
* v18.0.0 or Higher
4657
* Not required but recommend that you use [NVM](https://github.com/nvm-sh/nvm) to easily manage multiple versions of Node
58+
* [Python](https://www.python.org/downloads/)
59+
* v3.10.0 or higher
60+
* Required for Fable-Python
61+
4762

4863
#### Compiling
4964

@@ -52,6 +67,20 @@ GitHub Actions |
5267
$ ./build.sh <optional buildtarget>// on unix
5368
```
5469

70+
Without specifying a build target, the default target is `DotnetPack`, which will run tests for all projects on dotnet and then pack the projects into nuget packages. For additional notable targets see below.
71+
72+
##### Build Targets
73+
74+
- `Clean` - Will clean all projects `bin` and `obj` folders
75+
- `DotnetTest` - Will run tests for `dotnet` projects
76+
- `NpmTest` - Will run tests for `fable-javascript` projects
77+
- `PythonTest` - Will run tests for `fable-python` projects
78+
- `RunTests` - Will run tests for `dotnet`, `fable-javascript` and `fable-python` projects
79+
- `FormatCode` - Will run `fantomas` to format the codebase
80+
81+
This is not an exhausting list. Additional targets can be found in the `./build/build.fs` file.
82+
83+
5584
A motivating example
5685
--------------------
5786

0 commit comments

Comments
 (0)