|
28 | 28 | <a href=# id="public_changes"><h2 class="accordion_head"><span class="glyphicon glyphicon-play btn-xs"></span> Public Changes</h2></a>
|
29 | 29 | <div class="accordion_body">
|
30 | 30 | <p>
|
31 |
| -If your changes might be useful to others, then we encourage you to <a href="#submitting_a_change">submit them for inclusion into the product</a>. We will respond to all |
| 31 | +If your changes might be useful to others, then we encourage you to submit them for inclusion into the product. We will respond to all |
32 | 32 | submissions and give credit in the project record for submissions that are included.
|
| 33 | + </p><p> |
| 34 | +Click <a href="https://github.com/twpol/openrails/blob/feature/contributing/CONTRIBUTING.md">here for detailed advice and instructions for contributing to Open Rails</a>. |
33 | 35 | </p>
|
34 | 36 | </div>
|
35 | 37 | </li><li>
|
36 | 38 | <a href=# id="source_code_repository"><h2 class="accordion_head"><span class="glyphicon glyphicon-play btn-xs"></span> Version Control System</h2></a>
|
37 | 39 | <div class="accordion_body">
|
38 | 40 | <p>
|
39 |
| -The Open Rails project uses Subversion (SVN) as the versioning and revision control system for our software. |
40 |
| -Revisions are archived in a repository and can be compared, restored and merged, so that versions are safe and several developers can work |
| 41 | +The Open Rails project uses Git as the versioning and revision control system for our software. |
| 42 | +Revisions are kept in <a href="https://github.com/openrails/openrails">a public repository at GitHub.com</a> and can be compared, restored and merged, so that versions are safe and several developers can work |
41 | 43 | independently without (too much) conflict.
|
42 | 44 | </p><p>
|
43 |
| -The Open Rails source code is managed on <a href="http://svn.uktrainsim.com/svn/openrails/trunk">our Subversion server</a>. |
44 |
| -Read-only access is provided from the guest login: |
45 |
| - </p> |
46 |
| - <ul> |
47 |
| - <li>Username: <span class="tt">orpublic</span></li> |
48 |
| - <li>Password: <span class="tt">orpublic</span></li> |
49 |
| - </ul><br> |
50 |
| - <p> |
51 |
| -From your PC, you can use an Subversion client such as <a href="http://tortoisesvn.net">TortoiseSVN</a> to access the files, or simply view the repository from a web browser. |
| 45 | +From your PC, you can simply view the repository from a web browser. |
| 46 | +GitHub.com provides the GitHub Desktop program to interface between GitHub.com and your PC (for 64-bit Windows only). |
| 47 | +Other Windows programs are SourceTree and TortoiseGit and also Visual Studio includes a Git tool. |
52 | 48 | </p><p>
|
53 |
| -P.S. - Our thanks to <a href="http://www.uktrainsim.com">UKTrainSim.com</a> for donating the Subversion server space and admin services. |
54 |
| - </p> |
55 |
| - </div> |
56 |
| - </li><li> |
57 |
| - <a href=# id="accessing_the_code"><h2 class="accordion_head"><span class="glyphicon glyphicon-play btn-xs"></span> Accessing The Code With TortoiseSVN</h2></a> |
58 |
| - <div class="accordion_body"> |
59 |
| - <p> |
60 |
| -If you are not familiar with Subversion, please study the TortoiseSVN help first. |
61 |
| - </p> |
62 |
| - <ol> |
63 |
| - <li>From <i>Windows Explorer</i>, choose a folder to hold the project code.</li> |
64 |
| - <li>Right click on the folder, select <i>SVN Checkout...</i></li> |
65 |
| - <li>In the <i>Checkout</i> dialog box, enter the <i>URL of repository</i> : |
66 |
| - <span class="tt">http://svn.uktrainsim.com/svn/openrails/trunk</span> |
67 |
| - </li> |
68 |
| - <li>Enter username <span class="tt"> orpublic</span></li> |
69 |
| - <li>Enter password <span class="tt"> orpublic</span></li> |
70 |
| - <li>Check that the <i>Checkout directory</i> shows the folder where you want the files extracted to - e.g. |
71 |
| - <span class="tt">C:\Users\Wayne\Desktop\openrails</span> |
72 |
| - </li> |
73 |
| - <li>Click OK.</li> |
74 |
| - </ol><br> |
75 |
| - <p> |
76 | 49 | The main folders in the repository are:
|
77 |
| - </p> |
| 50 | + </p> |
78 | 51 | <ul>
|
79 | 52 | <li>Addons - accessory files shipped with the installation package</li>
|
80 | 53 | <li>Architecture - an incomplete experiment in restructuring the program</li>
|
81 |
| - <li>Archive - abandoned code</li> |
82 | 54 | <li>Documentation - operations manual and other documentation</li>
|
83 | 55 | <li>Program - empty space for executables once they are compiled</li>
|
84 | 56 | <li>Source - the principal source code files</li>
|
85 |
| - <li>SVNTesting - sandbox for training new users on SVN</li> |
| 57 | + <li>Website - source for this website</li> |
86 | 58 | </ul>
|
87 | 59 | </div>
|
88 | 60 | </li><li>
|
|
92 | 64 | To compile and debug the Open Rails source code, ensure you have the following Microsoft products installed:
|
93 | 65 | </p>
|
94 | 66 | <ul>
|
95 |
| - <li>Visual Studio 2015/17, any edition. The |
| 67 | + <li>Visual Studio 2015/17/19, any edition. The |
96 | 68 | <a href="https://www.visualstudio.com/downloads/">Community Edition</a>
|
97 | 69 | is free
|
98 | 70 | <br />(Note 1: To save on disk space, all you need is the option Windows > .NET Development)
|
|
132 | 104 | <li>Press F5 to run RunActivity.exe using your activity.</li>
|
133 | 105 | </ol>
|
134 | 106 | </div>
|
135 |
| - </li><li> |
136 |
| - <a href=# id="submitting_a_change"><h2 class="accordion_head"><span class="glyphicon glyphicon-play btn-xs"></span> Submitting A Change</h2></a> |
137 |
| - <div class="accordion_body"> |
138 |
| - <p> |
139 |
| -A change is best packaged as a "patch" file - a file which contains instructions to alter the current version of Open Rails code to |
140 |
| -include your changes. Patches are short and readable. Subversion will usually apply your patch successfully |
141 |
| -even after code has been changed by someone else. |
142 |
| - </p><p> |
143 |
| -If you are offering a fix to a Bug Report, then simply attach your patch file to the <a href="http://launchpad.net/or">Bug Tracker</a> explaining what you have done. |
144 |
| - </p><p> |
145 |
| -If you are offering an improvement or a new feature, then attach your file to a post on the Elvas Tower forum <a href="http://www.elvastower.com/forums/index.php?/forum/192-discussion/">Open Rails Discussion</a>. It would be helpful to post a message before |
146 |
| - you start work to give us some idea of your intentions. |
147 |
| - </p><p> |
148 |
| -We cannot promise that your changes will make it into the code, but show us what you can do and then we can talk about it. |
149 |
| - </p> |
150 |
| - </div> |
151 | 107 | </li>
|
152 | 108 | <li>
|
153 | 109 | <a href=# id="code_policy"><h2 class="accordion_head"><span class="glyphicon glyphicon-play btn-xs"></span> Policy for Code Changes</h2></a>
|
|
168 | 124 | <li><em>Targeted</em> means "Milestone" is set to the next planned stable version.</li>
|
169 | 125 | <li><em>Approved</em> means "Direction" is "Approved", "Milestone target" is unset or set to the next planned stable version, and at least 7 days of discussion has taken place.</li>
|
170 | 126 | </ol>
|
| 127 | + <br> |
171 | 128 | <p>
|
172 | 129 | For members of the <a href="../../discover/project-team/">Development Team</a>, these policies are defined in more detail in
|
173 |
| - <a href="http://www.elvastower.com/forums/index.php?/topic/26392-new-policy-for-code-changes/">New policy for code changes</a> |
| 130 | + <a href="http://www.elvastower.com/forums/index.php?/topic/26392-new-policy-for-code-changes/">Policy for code changes</a> |
174 | 131 | and
|
175 |
| - <a href="http://www.elvastower.com/forums/index.php?/topic/27109-new-policy-for-blueprints/">New policy for blueprints</a>. |
| 132 | + <a href="http://www.elvastower.com/forums/index.php?/topic/27109-new-policy-for-blueprints/">Policy for blueprints</a>. |
176 | 133 | </p>
|
177 | 134 | </div>
|
178 | 135 | </li>
|
|
0 commit comments