From 52e4c6bededa6b6c1991567ee4a1a841694dde12 Mon Sep 17 00:00:00 2001 From: servostar Date: Wed, 14 Feb 2024 20:38:46 +0100 Subject: [PATCH] added development section about vscode to readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e6f6098..854f2f2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ Gemstone is a programming language compiler written in C with lex and yacc. +## Development with VSCode/Codium + +Recommended extensions for getting a decent experience are the following: +- https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd +- https://marketplace.visualstudio.com/items?itemName=daohong-emilio.yash +- https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen +- https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools +- https://marketplace.visualstudio.com/items?itemName=twxs.cmake + +In order to remove false error messages from clangd CMake has to be run once in order generate compile_commands.json. + ## Build The build pipeline is configured with CMake in the file CMakeLists.txt. In order to avoid dependency and configuration issues the recommended way to build is by using the provided docker containers.