1d51be0e3d
Squashed commit: [9ae7dd0f] add helm-docs to workflow [2206f5ba] fix small typo in workflows (+1 squashed commits) Squashed commits: [29c2ceb4] Documentation-Cleanup (#181) * work on readme generation * document windows setup * add simple pre-commit install script * more docs for git setup * Update pre-commit * pre-commit automatic fixes * Increase all patch versions * Auto Readme and Config doc * Auto app-readme.md generation * increase common and common-test versions accordingly (due to cleanup) * move contribution guidelines to /development in wiki * fix some end-of-line issues (again) * fix line 14 of workflows
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# Setting up your dev environment
|
|
|
|
With TrueCharts we use some custom tools to make sure you have the least amount of work possible when working on the project.
|
|
However, this means you need some custom tools before you can start working on TrueCharts:
|
|
|
|
- Git (git client optional)
|
|
- Python (including Pip, added to path on windows)
|
|
- Pre-Commit (prefered)
|
|
|
|
## Windows
|
|
|
|
### Terminal basics:
|
|
When we talk about "In a terminal" we mean doing the following:
|
|
- hit windows+r
|
|
- enter "cmd"
|
|
|
|
### GIT
|
|
|
|
- Download and install GIT (https://git-scm.com/download/win)
|
|
- Most default options would be fine
|
|
|
|
In a terminal window or GUI client:
|
|
- Clone the repository in a specific directory of your choice (we will call this "Project-Root")
|
|
|
|
|
|
### Python
|
|
- Install Python3 with the installer (https://www.python.org/downloads/)
|
|
- Right click "Run as administrator"
|
|
- Check "Add to Path"
|
|
- Click the big install button
|
|
|
|
### Pre-Commit
|
|
Run .tools/pre-commit-install.bat
|
|
(Advanced users: This is for beginner users and will also execute "git config --unset-all core.hooksPath")
|
|
OR
|
|
In a terminal window:
|
|
- Enter "pip install pre-commit"
|
|
- CD to Project-Root
|
|
- Enter "pre-commit install"
|