Add readme

DataParser.Console/Program.fs

@@ -1,4 +1,5 @@
 // For more information see https://aka.ms/fsharp-console-apps
+open System
 open DataParser.Console.FileRead
 open DataParser.Console.FileWrite
 open DataParser.Console.Core
@@ -13,3 +14,6 @@ match specs with
     specs
     |> flip readDataFiles "./data"
     |> Array.iter (function Error e -> raise (invalidOp $"{e}") | Ok result -> writeOutputFile "./output" result)
+
+printfn "Output complete. Press Enter to exit."
+ignore <| Console.ReadLine()

README.md

@@ -0,0 +1,25 @@
+# Data Parser
+
+This is a simple program that parses data files contained in the `/data` folder using formats specified in the `/specs` folder.
+
+The whole program is written in F#.
+
+## Dependencies
+
+[.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download/visual-studio-sdks)
+
+## How to run
+
+1. `cd ./DataParser.Console/`
+2. `dotnet run`
+
+## Tests
+
+Unit tests can be found under `./DataParser.Tests`, these can be run with:
+
+1. `cd ./DataParser.Tests/`
+2. `dotnet test`
+
+## Docker image
+
+A docker image can be built by using the `Dockerfile`/`docker-compose.yml` file provided in the root directory.