diff --git a/.vsconfig b/.vsconfig new file mode 100644 index 0000000..7e5f20c --- /dev/null +++ b/.vsconfig @@ -0,0 +1,34 @@ +{ + "version": "1.0", + "components": [ + "Microsoft.VisualStudio.Component.CoreEditor", + "Microsoft.VisualStudio.Workload.CoreEditor", + "Microsoft.VisualStudio.Component.Roslyn.Compiler", + "Microsoft.Component.MSBuild", + "Microsoft.VisualStudio.Component.Roslyn.LanguageServices", + "Microsoft.VisualStudio.Component.TextTemplating", + "Microsoft.VisualStudio.Component.NuGet", + "Microsoft.VisualStudio.Component.Debugger.JustInTime", + "Microsoft.VisualStudio.Component.IntelliCode", + "Component.VisualStudio.GitHub.Copilot", + "Microsoft.VisualStudio.Component.VC.CoreIde", + "Microsoft.VisualStudio.Component.VC.Tools.x86.x64", + "Microsoft.VisualStudio.Component.Graphics.Tools", + "Microsoft.VisualStudio.Component.VC.DiagnosticTools", + "Microsoft.VisualStudio.Component.VC.ATL", + "Microsoft.VisualStudio.Component.VC.Redist.14.Latest", + "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core", + "Microsoft.VisualStudio.Component.Windows11Sdk.WindowsPerformanceToolkit", + "Microsoft.VisualStudio.Component.CppBuildInsights", + "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake", + "Microsoft.VisualStudio.Component.VC.CMake.Project", + "Microsoft.VisualStudio.Component.VC.TestAdapterForBoostTest", + "Microsoft.VisualStudio.Component.VC.TestAdapterForGoogleTest", + "Microsoft.VisualStudio.Component.VC.ASAN", + "Microsoft.VisualStudio.Component.Vcpkg", + "Microsoft.VisualStudio.Component.Windows10SDK.20348", + "Microsoft.VisualStudio.Workload.NativeDesktop", + "Microsoft.VisualStudio.Component.Git" + ], + "extensions": [] +} \ No newline at end of file diff --git a/README.md b/README.md index 5196cb2..a631aea 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,11 @@ return status code. - (⭐️) [Install and run directly with make](#install-and-run-directly-with-make) require runtime tools and GNU make installed in your SO. + +> [!NOTE] +> Please see [Environment Notes](docs/Environment-Notes.md) for more details +> about the tools required for your environment. In particular, **Windows**. + - [Install and in Docker](#install-and-running-with-docker-) require Docker and docker compose installed. - [Install and in Docker with make](#install-and-running-with-docker--using-make) diff --git a/Environment-Notes.md b/docs/Environment-Notes.md similarity index 82% rename from Environment-Notes.md rename to docs/Environment-Notes.md index 6b2bcf4..ebd5f4b 100644 --- a/Environment-Notes.md +++ b/docs/Environment-Notes.md @@ -1,5 +1,7 @@ # Environment notes +## For MacOS + OS: MacOS Sonoma 14.6.1 (23G93) ```sh @@ -10,11 +12,7 @@ uname -a 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 ``` -## Enable debugging with VSCode - - - -## Tools +### Tools Required tools: @@ -31,6 +29,27 @@ brew install clang-format cppcheck make vcpkg ``` +## IDE: Windows (Visual Studio 2022) + +Required components: + +- NuGet +- Redistributable update for C++ 2022 +- CMake tools for C++ in Windows +- AddressSanitizer for C++ +- vcpkg +- Windows 10 SDK +- Git for windows + +Please, import [.vsconfig file](../.vsconfig) in your +Visual Studio Installer to set up required environment tools. + +## Any OS: IDE: VSCode Notes + +### Enable debugging with VSCode + + + ## Visual Studio Code extensions Suggested for a C++ stack