ShuriZma
/
Cxbx-Reloaded
mirror of https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve formatting, fix spelling error.

Margen67 2018-04-26 14:40:44 -07:00
parent 7d24ca139c
commit f1fae4c08e
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Developer-notes.md

@ -1,23 +1,28 @@
## Developer environment ## Developer environment
Cxbx-Reloaded is developed in C++ using [Microsoft Visual Studio 2017 Community](https://www.visualstudio.com/downloads/). (The older 2015 version works too). Cxbx-Reloaded is developed in C++ using [Microsoft Visual Studio 2017 Community](https://www.visualstudio.com/downloads/).
The older 2015 version works too.
## Debugging during emulation ## Debugging during emulation
Since Cxbx-Reloaded launches another process instance of itself for emulation, debugging in Visual Studio doesn't work out of the box. Since Cxbx-Reloaded launches another process instance of itself for emulation, debugging in Visual Studio doesn't work out of the box.
This can easily be remedied, by installing and enabling the [Microsoft Child Process Debugging Power Tool](https://marketplace.visualstudio.com/items?itemName=GreggMiskelly.MicrosoftChildProcessDebuggingPowerTool).
This can easily be remedied by installing, and enabling the [Microsoft Child Process Debugging Power Tool](https://marketplace.visualstudio.com/items?itemName=GreggMiskelly.MicrosoftChildProcessDebuggingPowerTool).
## How to properly send your code contributions (git) ## How to properly send your code contributions (git)
This is a step-by-step guide to keep your forked copy of Cxbx-Reloaded updated, to create a branch for your work and to send a PR. This is a step-by-step guide to keep your forked copy of Cxbx-Reloaded updated, to create a branch for your work and to send a PR.
If you want more informations about git commands, you can read [this free book](https://git-scm.com/book/en/v2). If you want more informations about git commands, you can read [this free book](https://git-scm.com/book/en/v2).
### First time setup (aka adding the upstream remote) ### First time setup (aka adding the upstream remote)
You have to follow these steps only the first time you fork Cxbx-Reloaded: You have to follow these steps only the first time you fork Cxbx-Reloaded:
1) Fork mainline Cxbx-Reloaded repository on GitHub by clicking the "Fork" button (upper-right) and clone it to a local folder. 1) Fork mainline Cxbx-Reloaded repository on GitHub by clicking the "Fork" button (upper-right) and clone it to a local folder.
2) Open a git shell in the root folder of your cloned repository and paste this command (without quotes): "`git remote add upstream https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git`". 2) Open a git shell in the root folder of your cloned repository and paste this command (without quotes): "`git remote add upstream https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git`".
3) Then type (without quotes) "`git remote -v`". If you see two "`origin`" and two "`upstream`"; Congratulations, you have completed the first-time setup! 3) Then type (without quotes) "`git remote -v`". If you see two "`origin`" and two "`upstream`";
Congratulations, you have completed the first-time setup!
### Keep your fork updated ### Keep your fork updated
You have to follow these steps anytime you want to update your forked Cxbx-Reloaded repository: You have to follow these steps anytime you want to update your forked Cxbx-Reloaded repository:
@ -27,8 +32,10 @@ You have to follow these steps anytime you want to update your forked Cxbx-Reloa
### Create a branch for your new contribution ### Create a branch for your new contribution
You must keep the master branch of your forked repository clean, and instead create a new branch for every contribution you want to send. You must keep the master branch of your forked repository clean, and instead create a new branch for every contribution you want to send.
Before creating a branch, MAKE SURE YOUR FORK IS UP-TO-DATE! Before creating a branch, MAKE SURE YOUR FORK IS UP-TO-DATE!
Please change "name_of_new_branch" with something meaningfull like "fixing-issue-X".
Change "name_of_new_branch" to something meaningful like "fixing-issue-X".
1) Create a branch using this command (without quotes): "`git checkout -b name_of_new_branch`". 1) Create a branch using this command (without quotes): "`git checkout -b name_of_new_branch`".
2) Switch to your new branch with (without quotes): "`git checkout name_of_new_branch`". 2) Switch to your new branch with (without quotes): "`git checkout name_of_new_branch`".
3) Push your new branch on GitHub running (without quotes): "`git push origin name_of_new_branch`". 3) Push your new branch on GitHub running (without quotes): "`git push origin name_of_new_branch`".