Skip to content

Commit 6705173

Browse files
committed
v5.6.0 News article spelling and other fixes
1 parent 4447e11 commit 6705173

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

docs/news/posts/20260501.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,29 +133,38 @@ Get the source code from GitHub with GitHub Desktop:
133133
- Select a folder for the Local Path into which the repository will be cloned, use a final folder name of CommandStation-EX if you intend to use the Arduino IDE, or anything you like if using Visual Studio Code and PlatformIO
134134
- Click Clone
135135
- Once downloaded, choose v5.6.0-Prod in the Current Branch drop-down
136+
- copy any custom configuration files you want to keep from your old install (config.h, myAutomation.h, mySetup.h, etc.) into the new folder
136137

137138
You may then open the Arduino IDE and point it at the CommandStation-EX folder, or Visual studio code (GitHub Desktop can launch VSC for you.)
138139

139140
Get the source code directly from within Visual Studio Code:
140141
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141142

143+
Existing Visual Studio Code users can sync their local repository with the remote one and select the new branch directly from the Current Branch drop-down in the bottom left of the window. This will not overwrite your existing custom configuration files (config.h, myAutomation.h, mySetup.h, etc.)
144+
145+
For new Visual Studio Code users, you can clone the repository directly from within Visual Studio Code as follows:
146+
142147
- open a new window and using the "Clone Git Repository" option in the welcome screen, and pasting in the URL above
143148
- you can then select the folder into which to clone, and once downloaded, choose v5.6.0-Prod in the Current Branch drop-down
144149

145-
Get the source code from GitHub with git from command line:
146-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
150+
Get the source code from GitHub with git using the command line:
151+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
152+
153+
For those comfortable with using git on the command line and where git is already installed, you can use the following commands to clone the repository and checkout the v5.6.0-Prod tag:
147154

148155
.. code-block::
149156
150157
git clone https://github.com/DCC-EX/CommandStation-EX.git
151158
cd CommandStation-EX
152159
git checkout v5.6.0-Prod
153160
154-
If you already have git in use, a `git pull` command is needed to update your local files, and then the last command above to checkout the tag (or branch) you want to use.
161+
Be sure to copy any custom configuration files you want to keep from your old install (config.h, myAutomation.h, mySetup.h, etc.) into the new folder.
162+
163+
If you already have an older copy of |ex-cs| in use that you want to update, a `git pull` command is needed to update your local files, and then issue the checkout command above to checkout the tag (or branch) you want to use. The git pull will not overwrite your custom configuration files.
155164

156165
Get the source code from the archive files:
157166
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
158167

159-
The archive files are availale for download at https://github.com/DCC-EX/CommandStation-EX/releases/tag/v5.6.0-Prod Please choose one of the first two, the zip or tar.gz, not the last two which are autogenerated by github and contain the wrong directory name.
168+
The GitHub Release archive files are available for download at https://github.com/DCC-EX/CommandStation-EX/releases/tag/v5.6.0-Prod Please choose one of the first two, the zip or tar.gz, not the last two which are autogenerated by github and contain the wrong directory name.
160169

161-
Be sure to unpack in a new folder, not over the top of an old install.
170+
Be sure to unpack in a new folder, not over the top of an old install, and to copy over any custom configuration files you want to keep from your old install (config.h, myAutomation.h, mySetup.h, etc.) into the new folder. If using the Arduino IDE, be sure to rename the new folder CommandStation-EX before opening it in the IDE. If using Visual Studio Code with PlatformIO, you can name the folder anything you like and simply open it.

0 commit comments

Comments
 (0)