From 9835ce0093a1fc1d32b3867eea4d370749cde11e Mon Sep 17 00:00:00 2001 From: Arthur Bit-Monnot Date: Fri, 24 Nov 2023 15:22:28 +0100 Subject: [PATCH] Minor changes to readme and vscode config --- .vscode/tasks.json | 13 +++++++++++-- README.md | 9 +++++---- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index a58e5bf..0a9e349 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -4,13 +4,22 @@ "version": "2.0.0", "tasks": [ { - "label": "make", + "label": "make build", "type": "shell", - "command": "make", + "command": "make build", "group": { "kind": "build", "isDefault": true } + }, + { + "label": "make demo", + "type": "shell", + "command": "make demo", + "group": { + "kind": "test", + "isDefault": true + } } ] } \ No newline at end of file diff --git a/README.md b/README.md index 2ee1f32..a2e1417 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ 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. +To use, you should install the *OCaml Platform* extension in VSCode. Then open VSCode in the root directory of this repository (command line: `code path/to/ocaml-maxflow-project`). Features : - full compilation as VSCode build task (Ctrl+Shift+b) - highlights of compilation errors as you type - code completion - - automatic indentation on file save + - view of variable types -A makefile provides some useful commands: - - `make build` to compile. This creates an ftest.native executable +A [`Makefile`](Makefile) provides some useful commands: + + - `make build` to compile. This creates an `ftest.exe` executable - `make demo` to run the `ftest` program with some arguments - `make format` to indent the entire project - `make edit` to open the project in VSCode