diff --git a/README.md b/README.md new file mode 100644 index 0000000..09ea463 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +Base project for Ocaml project on Ford-Fulkerson. This project contains some simple configuration files to facilitate editing Ocaml in VSCode. + +To use, you should install the *OCaml* extension in VSCode. Other extensions might work as well but make sure there is only one installed. +Then open VSCode in the root directory of this repository. + +Features : + - full compilation as VSCode build task (Ctrl+Shift+b) + - highlights of compilation errors as you type + - code completion + - automatic indentation on file save + + +A makefile also provides basic automation : + + - `make` to compile. This creates an ftest + - `make format` to indent the entire project +