Add README and GitHub workflow

.github/workflows/dotnet-core.yaml

@@ -16,7 +16,7 @@ jobs:
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 6.0.400
+        dotnet-version: 6.0.100
     - name: Install dependencies
       run: dotnet restore Raft.sln
     - name: Build
@@ -26,4 +26,4 @@ jobs:
     - name: Install Fantomas
       run: dotnet tool restore
     - name: Run Fantomas
-      run: ./hooks/pre-push
+      run: dotnet tool run fantomas --check -r .

README.md

@@ -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
+```
+