Minor changes to readme and vscode config

This commit is contained in:
Arthur Bit-Monnot 2023-11-24 15:22:28 +01:00
parent 0834c2ea59
commit 9835ce0093
2 changed files with 16 additions and 6 deletions

13
.vscode/tasks.json vendored
View file

@ -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
}
}
]
}

View file

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