You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-4Lines changed: 52 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,6 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
8
8
9
9
The tool is written in the Rust programming language.
10
10
11
-
It has not been tested on Microsoft Windows.
12
-
13
11
14
12
## Installing newdoc
15
13
@@ -18,17 +16,29 @@ It has not been tested on Microsoft Windows.
18
16
```
19
17
# dnf copr enable mareksu/newdoc-rs
20
18
# dnf install newdoc
19
+
20
+
$ newdoc
21
21
```
22
22
23
-
* On a different Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
23
+
* To install `newdoc` as a Docker image, use the `docker` or `podman` tool. If you use `podman`, replace `docker` with `podman` in the following commands:
24
+
25
+
```
26
+
$ docker pull mrksu/newdoc
27
+
28
+
$ docker run mrksu/newdoc
29
+
```
30
+
31
+
32
+
* To install `newdoc` from source on a Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
24
33
25
34
```
26
35
$ cargo install newdoc
36
+
37
+
$ newdoc
27
38
```
28
39
29
40
For installing `cargo`, see <https://rustup.rs/>.
30
41
31
-
Note that `newdoc` has not been tested on Microsoft Windows.
32
42
33
43
## Creating a new module
34
44
@@ -106,6 +116,44 @@ It has not been tested on Microsoft Windows.
106
116
8. Click **Build**.
107
117
108
118
119
+
## Packaging and distributing newdoc as a Docker image
120
+
121
+
Note: The following steps might be sub-optimal. Feel free to suggest improvements.
122
+
123
+
1. Install the `docker` or `podman` tool.
124
+
125
+
If you use `podman`, replace `docker` with `podman` in the following commands.
0 commit comments