Skip to content

Commit f747f5e

Browse files
author
Chris Jakeman
committed
add some missing images
1 parent e08c088 commit f747f5e

File tree

3 files changed

+29
-25
lines changed

3 files changed

+29
-25
lines changed

Docs/Building.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Download and install Visual Studio 2019 Community Edition from Microsoft.
2323

2424
![](images/authorising_visual_studio_installer.png)
2525

26-
![](images/prompt_from_visual_studio_installer.png)<br />
26+
![](images/prompt_from_visual_studio_installer.png)
2727

2828
### VS Installation
2929

@@ -50,13 +50,15 @@ You will be prompted to "Get started" and should "Clone a repository" from
5050

5151
![](images/orts_solution.png)
5252

53-
On completion, the Solution Explorer view will list the solution ORTS.sln. Pick it to receive a prompt:
53+
On completion, the Solution Explorer view will list the solution ORTS.sln.
54+
55+
Pick it to receive a prompt:
5456

5557
![](images/framework_not_installed.png)
5658

5759
The purpose of the Launcher project is to check whether the user's PC has the software libraries installed to run Open Rails. It uses libraries which are installed on even old PCs, so that it can run on them without error and report any problems.
5860

59-
However the framework needed to build that project is not installed automatically, so choose the option highlighted in the image above. <p>&nbsp;</p>
61+
However the framework needed to build that project is not installed automatically, so choose the option highlighted by the cursor in the image above. <p>&nbsp;</p>
6062

6163
![](images/open_rails_projects.png)
6264

@@ -68,7 +70,7 @@ Note: There is no project called OpenRails. Instead, the Launcher project builds
6870

6971
![](images/build_projects.png)
7072

71-
Use *Build > Rebuild Solution* to compile and link the source code into executable and DLL files.
73+
Use *Build > Rebuild Solution* to compile and link the source code into executable and DLL files.<p>&nbsp;</p>
7274

7375
![](images/successful_build.png)
7476

@@ -90,7 +92,7 @@ Now pressing F5, Start or *Debug > Start Debugging* will launch the project Menu
9092

9193
## Content
9294

93-
Without content, all you can run is Menu.exe (or OpenRails.exe which runs Menu.exe) and some of the contributed tools.<p>&nbsp;</p>
95+
Without content, all you can run is Menu.exe (or OpenRails.exe which runs Menu.exe) and some of the contributed tools.
9496

9597
![](images/menu_option_content.png)
9698

@@ -103,11 +105,11 @@ Unzip into a new folder.<p>&nbsp;</p>
103105

104106
![](images/add_demo_model_1.png)
105107

106-
Start Open Rails Menu.exe, and use *Options > Content > Add* to add the folder "Demo Model 1" to the list of installation profiles.<p>&nbsp;</p>
108+
Using Open Rails Menu.exe and *Options > Content > Add*, add the folder "Demo Model 1" to the list of installation profiles.<p>&nbsp;</p>
107109

108110
![](images/installation_profiles.png)
109111

110-
Select Demo model 1 as the Installation profile.
112+
Select Demo model 1 as the Installation profile.<p>&nbsp;</p>
111113

112114
![](images/start_activity.png)
113115

@@ -121,12 +123,14 @@ From Visual Studio, using *Project > Properties > Debug > Command line arguments
121123

122124
## Installing Tools for Open Rails Manual
123125

124-
Note: This section is based on this [Pull Request](https://github.com/openrails/openrails/pull/557)
125-
There are several components to install but after that producing a revised manual is just a click away.
126+
The Open Rails manual is written in [ReStructuredText](https://docutils.sourceforge.io/rst.html) which is processed into a [multi-page HTML document](https://open-rails.readthedocs.io/en/latest/) or a [single-page PDF document](http://openrails.org/files/OpenRails-Testing-Manual.pdfvmw).
127+
128+
Note: This section is based on this [Pull Request](https://github.com/openrails/openrails/pull/557).
129+
There are several components to install but, after that, producing a revised manual is just a click away.
126130

127131
### Install Visual Studio Code
128132

129-
This interactive development environment (IDE) is unrelated to the Visual Studio IDE. The Open Rails manual is written in [ReStructuredText](https://docutils.sourceforge.io/rst.html) which is processed into a [multi-page HTML document](https://open-rails.readthedocs.io/en/latest/) or a [single-page PDF document](http://openrails.org/files/OpenRails-Testing-Manual.pdfvmw).
133+
This interactive development environment (IDE) is not related to the Visual Studio IDE.
130134

131135
### Download and install Visual Code
132136

@@ -136,11 +140,11 @@ Download from [Download Visual Studio Code - Mac, Linux, Windows](https://code.v
136140

137141
![](images/add_vs_extension.png)
138142

139-
Use the icon to add a new extension.
143+
Use the icon to add a new extension.<p>&nbsp;</p>
140144

141145
![](images/search_for_remote_containers.png)
142146

143-
Search for the extension "Remote Containers".
147+
Search for the extension "Remote Containers".<p>&nbsp;</p>
144148

145149
![](images/install_remote_containers.png)
146150

@@ -152,11 +156,11 @@ And install it into Visual Studio Code.
152156

153157
Download from [https://docs.docker.com/desktop/windows/install/](https://docs.docker.com/desktop/windows/install/) and run the installer.
154158

155-
Docker provides a closed environment so that our script to build the manual can be run knowing that it will not be broken by any subsequent changes on the PC.
159+
Docker provides a closed environment so that our script to build the manual can be run knowing that it will not be broken by any subsequent changes on the PC.<p>&nbsp;</p>
156160

157161
![](images/settings_for_docker_desktop.png)
158162

159-
Use the default settings.
163+
Use the default settings.<p>&nbsp;</p>
160164

161165
![](images/progress_for_docker_desktop.png)
162166

@@ -166,27 +170,27 @@ You will be prompted to close and restart your PC.
166170

167171
![](images/wsl2_for_docker_desktop.png)
168172

169-
You may receive a prompt to install WSL 2 separately. Click the link.
173+
You may receive a prompt to install WSL 2 separately. Click the link to the website.
170174

171175
![](images/enable_virtual_machine.png)
172176

173-
The link takes you to Step 3 and 4.
177+
The link takes you to Step 3 and 4.<p>&nbsp;</p>
174178

175179
![](images/run_powershell.png)
176180

177-
Run PowerShell as Administrator.
181+
Run PowerShell as Administrator.<p>&nbsp;</p>
178182

179183
![](images/enable_virtual_machine_feature.png)
180184

181-
Enter the command provided.
185+
Enter the command provided.<p>&nbsp;</p>
182186

183187
![](images/download_wsl_2.png)
184188

185-
Return to the webpage for Step 4 and download WSL 2 and install it.
189+
Return to the webpage for Step 4 and download WSL 2 and install it. <p>&nbsp;</p>
186190

187191
![](images/install_wsl_2.png)
188192

189-
Once this is installed, return to the Docker Desktop prompt and press Restart.
193+
Once this is installed, return to the Docker Desktop prompt and press Restart.<p>&nbsp;</p>
190194

191195
![](images/restart_docker_desktop.png)
192196

@@ -196,23 +200,23 @@ Now that Docker Desktop is running, start Visual Studio Code.
196200

197201
![](images/find_vsc_commands.png)
198202

199-
Press F1 to find the command list and search for Remote Containers: Open Folder in Container...
203+
Press F1 to find the command list and search for Remote Containers: Open Folder in Container...<p>&nbsp;</p>
200204

201205
![](images/find_manual_folder.png)
202206

203-
Using Windows File Explorer, search your repository for Source\Documentation\Manual
207+
Using Windows File Explorer, search your repository for Source\Documentation\Manual<p>&nbsp;</p>
204208

205209
![](images/manual_file_list.png)
206210

207-
All the manual files will be listed.
211+
All the manual files will be listed. <p>&nbsp;</p>
208212

209213
![](images/build_html_manual.png)
210214

211-
To build the manual, enter a command in the Terminal pane of Visual Studio Code. The default command is "make html" which builds the file Source\Documentation\Manual\_build\html\index.html
215+
To build the manual, enter a command in the Terminal pane of Visual Studio Code. The default command is _make html_ which builds the file Source\Documentation\Manual\\_build\html\index.html<p>&nbsp;</p>
212216

213217
![](images/html_manual.png)
214218

215-
There is a shortcut for this command: Ctrl+Shift+B.
219+
There is a shortcut for this command: Ctrl+Shift+B.<p>&nbsp;</p>
216220

217221
![](images/pdf_manual.png)
218222

Docs/images/build_projects.png

39.7 KB
Loading
42.9 KB
Loading

0 commit comments

Comments
 (0)