weyne/dcs-retribution
1
0
Fork 0
mirror of https://github.com/dcs-retribution/dcs-retribution.git synced 2025-11-10 15:41:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update git docs.

Dan Albert 2021-05-10 17:17:56 -07:00
parent c0e5e5f6cf
commit ab44a043d6
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Developer's-Guide.md

@ -27,6 +27,20 @@ When you install Python, make sure to install pip for dependencies management. T
* **master** : Should be even with current release version
* **develop** : Current version being worked on, might be unstable
The following instructions work for the git command line. If using the GitHub Desktop or `gh` tools, the steps will be the same but the exact commands will differ.
To get started with development, run:
```
git clone --recurse-submodules https://github.com/dcs-liberation/dcs_liberation.git
```
This will automatically check out the develop branch. The `--recurse-submodules` flag ensures that our local copy of `pydcs` (a dependency we use) is also checked out. It is also a good idea to configure `git pull` to automatically update submodules. To do this, run:
```
git config --global submodule.recurse true
```
## Creating a Python virtual environment
A Python virtual environment (virtualenv) is a local copy of the Python distribution for a specific project. This allows you to install the project dependencies local to the environment rather than globally on your system, which makes it easier to reset your environment if something goes wrong.
@ -60,6 +74,6 @@ https://github.com/Khopa/dcs_liberation/wiki/Release-process
Please make a new branch from either develop or master, and make your pull requests to khopa/develop.
If you're new to GitHub, https://guides.github.com/introduction/flow/ and the other tutorials on that site may be helpful.