Add README and GitHub workflow

This commit is contained in:
Smaug123
2022-10-27 22:06:03 +01:00
parent cce92eb9fd
commit a4e1a2dbdc
2 changed files with 19 additions and 2 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Raft
A Raft implementation in F#.
# Development tips
There are pull request checks on this repo, enforcing [Fantomas](https://github.com/fsprojects/fantomas/)-compliant formatting.
After checking out the repo, you may wish to add a pre-push hook to ensure locally that formatting is complete, rather than having to wait for the CI checks to tell you that you haven't formatted your code.
Consider performing the following command to set this up in the repo:
```bash
git config core.hooksPath hooks/
```
Before your first push (but only once), you will need to install the [.NET local tools](https://docs.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use) which form part of the pre-push hook:
```bash
dotnet tool restore
```