Git: Setup and First Steps
Install a Development Environment
Install an integrated development environment of your choice.
- Currently, Microsoft Visual Studio Code seems to be a popular integrated development environment.
- Download installer from https://code.visualstudio.com/
- Disable telemetry after installation, cf. https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting
- File -> Preference -> Settings. Set Telemetry Level to off.
- Pycharm could be an alternative.
Install Default Editor for git
Whenever a text comment is required by a git command and none is given via command line then a default editor is started. It should be comfortable, yet lightweight.
- Linux: kate is an option.
- Windows: Notepad++ is decent.
- Get installer from https://notepad-plus-plus.org/downloads/ .
- Accept defaults during installation.
Install git
- Get installer for your OS from https://git-scm.com/install/ .
- Accept defaults during installation with these exceptions:
- Choosing the default editor used by Git: Select default editor from above.
- Adjusting the name of the initial branch in new repositories: Override the default branch name for new repositories: main.
Install GUI (Optional)
On Windows, the Explorer plug-in TortoiseGit can be helpful, although everything can be done on command line in GitBash. The TortoiseGit operations are available in the Explorer context menu.
- Install MSVC++ Redistributable, which is a prerequisite to TortoiseGit:
- Get it from https://visualstudio.microsoft.com/downloads/ -> Other Tools, Frameworks, and Redistributables -> Microsoft Visual C++ v?? Redistributable. For v?? use the latest version.
- Install TortoiseGit
- Get installer from https://tortoisegit.org/download/ .
- Select the OpenSSH option during installation.
Git LFS (Large File System)
For a more efficient handling of large binary files, git LFS is used. It needs to be installed once per machine (already done on the lab PCs).
- Open GitBash and enter
git lfs install.
Set up SSH
For a secure communication between work PC and gitlab either SSH or HTTPs can be used. SSH is recommended.
- Generate new SSH key if none available yet:
- Upload public SSH key to gitlab
Before you can access https://gitlab.lrz.de you need to accept the invitation to this project which you should have received by email.
Initial Clone of the ProCK Repository
Pull the ProCK repository owned by hm-stehr to your local machine.
- Recommended: Via SSH
- In GitBash:
git clone git@gitlab.lrz.de:hm-stehr/prock.git
- In GitBash:
- Also possible: Via HTTPS
- In GitBash:
git clone https://gitlab.lrz.de/hm-stehr/prock.git
- In GitBash:
You can inspect the repository on its website: https://gitlab.lrz.de/hm-stehr/prock
Git Resources
- Git help from LRZ gitlab: https://gitlab.lrz.de/help/
- Git cheat sheet: https://education.github.com/git-cheat-sheet-education.pdf
- Interactive tutorial: https://learngitbranching.js.org/
- Pro Git book: https://git-scm.com/book/en/v2
- If things go wrong, they can often be fixed: https://dangitgit.com/