Skip to content

Commit 28cb9b4

Browse files
author
Gonzalo Diaz
committed
[DOC] New "environment notes" to document the installation of the tool stack used in this project.
1 parent 1112d9d commit 28cb9b4

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

Environment-Notes.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Environment notes
2+
3+
OS: MacOS Sonoma 14.6.1 (23G93)
4+
5+
```sh
6+
uname -a
7+
```
8+
9+
```text
10+
Darwin epoch.local 23.6.0 Darwin Kernel Version 23.6.0: Mon Jul 29 21:13:00 PDT 2024; root:xnu-10063.141.2~1/RELEASE_X86_64 x86_64
11+
```
12+
13+
## Enable debugging with VSCode
14+
15+
<https://github.com/microsoft/vscode-cmake-tools/issues/3034>
16+
17+
## Tools
18+
19+
Required tools:
20+
21+
- Homebrew
22+
- Xcode command line tools
23+
24+
<https://www.freecodecamp.org/news/install-xcode-command-line-tools/>
25+
26+
Then, the C++ local stack I choose:
27+
28+
```sh
29+
brew install --cask cmake
30+
brew install clang-format cppcheck make vcpkg
31+
32+
```
33+
34+
## Visual Studio Code extensions
35+
36+
Suggested for a C++ stack
37+
38+
```sh
39+
code --install-extension ms-vscode.cpptools-extension-pack
40+
code --install-extension ms-vscode.cmake-tools
41+
code --install-extension xaver.clang-format
42+
code --install-extension ryanluker.vscode-coverage-gutters
43+
code --install-extension NathanJ.cpp-tools-plugin
44+
code --install-extension ms-vscode.makefile-tools
45+
```
46+
47+
General purpose
48+
49+
```sh
50+
code --install-extension ms-azuretools.vscode-docker
51+
code --install-extension EditorConfig.EditorConfig
52+
code --install-extension donjayamanne.githistory
53+
code --install-extension shd101wyy.markdown-preview-enhanced
54+
code --install-extension DavidAnson.vscode-markdownlint
55+
code --install-extension bpruitt-goddard.mermaid-markdown-syntax-highlighting
56+
code --install-extension esbenp.prettier-vscode
57+
code --install-extension redhat.vscode-yaml
58+
```
59+
60+
Optional (cosmetic purpose)
61+
62+
```sh
63+
code --install-extension aaron-bond.better-comments
64+
code --install-extension isotechnics.commentlinks
65+
code --install-extension johnpapa.vscode-peacock
66+
code --install-extension vscode-icons-team.vscode-icons
67+
```
68+
69+
Extra for complementary external services
70+
71+
```sh
72+
code --install-extension snyk-security.snyk-vulnerability-scanner
73+
code --install-extension SonarSource.sonarlint-vscode
74+
code --install-extension github.vscode-github-actions
75+
76+
```

0 commit comments

Comments
 (0)