templates-project_setup/README.md

24 lines
749 B
Markdown
Raw Normal View History

2020-04-07 12:38:31 +00:00
# Templates for Coding Projects
Author: Jannik Beyerstedt
2020-04-08 17:08:50 +00:00
**License**: CC BY 4.0
2020-04-07 12:38:31 +00:00
Here goes the general project description in a few sentences.
In this case, this repo collects all of the bootstrapping files needed for different programming languages.
## Installation
Just copy the files, that are needed for your project's toolchain, to your repository.
## Usage
For all projects use:
2020-07-14 07:02:35 +00:00
- .editorconfig (VS Code Extension: `editorconfig.editorconfig`)
2020-04-07 12:38:31 +00:00
For C/C++ use:
2020-07-14 07:02:35 +00:00
- .clang-format (VS Code Extensions: `ms-vscode.cpptools`, optionally `ms-vscode.cmake-tools`, `twxs.cmake`)
2020-04-07 12:38:31 +00:00
For Python use:
2020-07-14 07:02:35 +00:00
- .pep8 (VS Code Extensions: `ms-python.python`. PIP Package: `autopep8`)
- pylintrc (VS Code Extensions: `ms-python.python`. PIP Package: `pylint`)
2020-04-07 12:06:46 +00:00