Skip to content

Commit 0a8c445

Browse files
Slawek-skraweksjanc
authored andcommitted
docs: install: Update install instructions for Windows
1 parent d5fea5a commit 0a8c445

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

docs/install/newt_windows.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide shows you how to perform the following:
1313

1414
1. Install MSYS2/MinGW.
1515
2. Install Git.
16-
3. Install latest release (1.8.0) of newt from binary.
16+
3. Install latest release of newt from binary.
1717
4. Install go for building newt from source.
1818
5. Install latest release of newt from source.
1919

@@ -93,7 +93,7 @@ You can install the latest release of newt from binary. It has been tested on Wi
9393

9494
1. Start a MinGW terminal.
9595

96-
2. Download the newt binary tar file `apache-mynewt-newt-bin-windows-1.8.0.tgz <https://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.8.0/apache-mynewt-newt-bin-windows-1.8.0.tgz>`__.
96+
2. Download the latest newt binary tar file for Windows from https://mynewt.apache.org/download.
9797

9898
3. Extract the file:
9999

@@ -102,13 +102,13 @@ You can install the latest release of newt from binary. It has been tested on Wi
102102

103103
.. code-block:: console
104104
105-
$ tar -xzf apache-mynewt-newt-bin-windows-1.8.0.tgz -C $GOPATH/bin --strip-components=1 apache-mynewt-newt-bin-windows-1.8.0/newt.exe
105+
$ tar -xzf apache-mynewt-newt-bin-windows-x.x.x.tgz -C $GOPATH/bin --strip-components=1 apache-mynewt-newt-bin-windows-x.x.x/newt.exe
106106
107107
- If you are installing newt for the first time and do not have a Go workspace setup, you can extract into /usr/bin directory:
108108

109109
.. code-block:: console
110110
111-
$ tar -xzf apache-mynewt-newt-bin-windows-1.8.0.tgz -C /usr/bin --strip-components=1 apache-mynewt-newt-bin-windows-1.8.0/newt.exe
111+
$ tar -xzf apache-mynewt-newt-bin-windows-x.x.x.tgz -C /usr/bin --strip-components=1 apache-mynewt-newt-bin-windows-x.x.x/newt.exe
112112
113113
4. Verify the installed version of newt. See `Checking the Installed Version`_.
114114

@@ -136,20 +136,19 @@ source.
136136

137137
1. Start a MinGw terminal.
138138

139-
2. Download and unpack the newt source:
139+
2. Download and unpack the newt source (get version number from https://mynewt.apache.org/download):
140140

141141
.. code-block:: console
142142
143-
$ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_8_0_tag.tar.gz
144-
$ tar -xzf /tmp/mynewt_1_8_0_tag.tar.gz
143+
$ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_x_x_x_tag.tar.gz
144+
$ tar -xzf /tmp/mynewt_x_x_x_tag.tar.gz
145145
146146
3. Run the build.sh to build the newt tool.
147147

148148
.. code-block:: console
149149
150-
$ cd mynewt-newt-mynewt_1_8_0_tag
150+
$ cd mynewt-newt
151151
$ MSYS=winsymlinks:nativestrict ./build.sh
152-
$ rm /tmp/mynewt_1_8_0_tag.tar.gz
153152
154153
4. You should see the ``newt/newt.exe`` executable. Move the executable to a bin directory in your PATH:
155154

@@ -173,14 +172,16 @@ Checking the Installed Version
173172

174173
.. code-block:: console
175174
175+
$ which newt
176+
/usr/bin/newt
176177
$ newt version
177-
Apache Newt 1.8.0 / ab96a8a-dirty / 2020-03-18_23:25
178+
Apache Newt 1.13.0 / c6bf556 / 2024-11-15_06:58
178179
179180
2. Get information about newt:
180181

181182
.. code-block:: console
182183
183-
$ newt help
184+
$ newt
184185
Newt allows you to create your own embedded application based on the Mynewt
185186
operating system. Newt provides both build and package management in a single
186187
tool, which allows you to compose an embedded application, and set of
@@ -204,6 +205,7 @@ Checking the Installed Version
204205
apropos Search manual page names and descriptions
205206
build Build one or more targets
206207
clean Delete build artifacts for one or more targets
208+
completion Generate the autocompletion script for the specified shell
207209
create-image Add image header to target binary
208210
debug Open debugger session to target
209211
docs Project documentation generation commands
@@ -225,13 +227,14 @@ Checking the Installed Version
225227
version Display the Newt version number
226228
227229
Flags:
228-
--escape Apply Windows escapes to shell commands (default true)
230+
--escape Apply Windows escapes to shell commands
229231
-h, --help Help for newt commands
230-
-j, --jobs int Number of concurrent build jobs (default 8)
232+
-j, --jobs int Number of concurrent build jobs (default 4)
231233
-l, --loglevel string Log level (default "WARN")
232234
-o, --outfile string Filename to tee output to
233235
-q, --quiet Be quiet; only display error output
236+
--shallow int Use shallow clone for git repositories up to specified number of commits
234237
-s, --silent Be silent; don't output anything
235238
-v, --verbose Enable verbose output when executing commands
236239
237-
Use "newt [command] --help" for more information about a command.
240+
Use "newt [command] --help" for more information about a command.

0 commit comments

Comments
 (0)