Skip to content
GitLab

VSCode DSPElib readme · Changes

Page history
Added info about doxygen authored by Marek Blok's avatar Marek Blok
Hide whitespace changes
Inline Side-by-side
VSCode-DSPElib-readme.md
View page @ ec933f4d
...@@ -34,16 +34,18 @@ Preparation for working with DSPElib using Visual Studio Code ...@@ -34,16 +34,18 @@ Preparation for working with DSPElib using Visual Studio Code
}, },
~~~ ~~~
- In Windows VSCode might require setting default terminal profile to Command Prompt (Ctrl+Shift+P: select default profile). - In Windows VSCode might require setting default terminal profile to Command Prompt (Ctrl+Shift+P: select default profile).
5. Open main folder DSPE_lib in VSC. 5. Optionally install Doxygen (https://www.doxygen.nl/) which can be used for generation of library documentation from source code.
6. .vscode/c_cpp_properties.json – C++ configurations - subfolder Doxydoc contains doxygen configuration files and windows batch files for documatation generation using doxygen.
6. Open main folder DSPE_lib in VSC.
7. .vscode/c_cpp_properties.json – C++ configurations
- https://code.visualstudio.com/docs/cpp/c-cpp-properties-schema-reference - https://code.visualstudio.com/docs/cpp/c-cpp-properties-schema-reference
- The status bar in VS Code will show you which configuration is active. You can also click on the label in the status bar to change the active configuration. - The status bar in VS Code will show you which configuration is active. You can also click on the label in the status bar to change the active configuration.
- first setup C++ in status bar - first setup C++ in status bar
- next select C++ Configuration in status bar, e.g. select "Windows64-Debug". - next select C++ Configuration in status bar, e.g. select "Windows64-Debug".
- \note: this determines compilation actions. - \note: this determines compilation actions.
7. .vscode/tasks.json 8. .vscode/tasks.json
- compilation tasks configurations - compilation tasks configurations
8. Compilation: 9. Compilation:
- in menu choose Terminal > Run Task... to select compilation task - in menu choose Terminal > Run Task... to select compilation task
- Ctrl+Shift+B - default compilation task - Ctrl+Shift+B - default compilation task
- Compilation actions depend on C++ language configuration (e.g. Windows64-Debug) - Compilation actions depend on C++ language configuration (e.g. Windows64-Debug)
...@@ -53,17 +55,17 @@ Preparation for working with DSPElib using Visual Studio Code ...@@ -53,17 +55,17 @@ Preparation for working with DSPElib using Visual Studio Code
- Install DSPElib - building both Debug and Release versions and copying library files to _DSPE_lib_minGW_ folder in the subforder depending on platform and the compiler - Install DSPElib - building both Debug and Release versions and copying library files to _DSPE_lib_minGW_ folder in the subforder depending on platform and the compiler
- build examples Windows/Linux (requires (depends on last) "Install DSPElib" done beforehand) - build examples Windows/Linux (requires (depends on last) "Install DSPElib" done beforehand)
- clean examples Windows/Linux - clean examples Windows/Linux
9. Debugging 10. Debugging
- launch.json - launch.json
- debuger path might need updating - debuger path might need updating
- https://code.visualstudio.com/docs/cpp/config-mingw - https://code.visualstudio.com/docs/cpp/config-mingw
10. Linux required sound libraries 11. Linux required sound libraries
- sudo apt install libasound2 - sudo apt install libasound2
- sudo apt-get install libasound2-dev - sudo apt-get install libasound2-dev
11. Git configuration in Linux 12. Git configuration in Linux
- git config --global user.email "me@example.com" - git config --global user.email "me@example.com"
- git config --global user.name "Your Name and Surname" - git config --global user.name "Your Name and Surname"
11. Wiki 13. Wiki
- https://git.pg.edu.pl/dspe/DSPElib/wikis/git_access - https://git.pg.edu.pl/dspe/DSPElib/wikis/git_access
......