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
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,24 +23,26 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
23
23
24
24
Note that the Copr repository distributes packages only for *supported* releases of Fedora. If you have enabled the repository but the package fails to install, check if your Fedora is still supported.
25
25
26
-
* 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:
26
+
* To install `newdoc` from source on a Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
27
27
28
28
```
29
-
$ docker pull mrksu/newdoc
29
+
$ cargo install newdoc
30
30
31
-
$ docker run mrksu/newdoc
31
+
$ newdoc
32
32
```
33
33
34
-
35
-
* To install `newdoc` from source on a Linux distribution, on macOS, or on Microsoft Windows, use the `cargo` package manager:
34
+
For installing `cargo`, see <https://rustup.rs/>.
35
+
36
+
* 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:
36
37
37
38
```
38
-
$ cargo install newdoc
39
+
$ docker pull mrksu/newdoc
39
40
40
-
$ newdoc
41
+
$ docker run mrksu/newdoc
41
42
```
43
+
44
+
**Warning:** The container currently does not generate files properly. For details and a workaround, see [Issue #17](https://github.com/redhat-documentation/newdoc/issues/17).
42
45
43
-
For installing `cargo`, see <https://rustup.rs/>.
44
46
45
47
## Updating newdoc
46
48
@@ -50,16 +52,16 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
50
52
# dnf upgrade newdoc
51
53
```
52
54
53
-
* To update `newdoc` from Docker, use the `docker` or `podman` tool:
55
+
* To update `newdoc` from source, use the `cargo` package manager:
54
56
55
57
```
56
-
$ docker pull mrksu/newdoc
58
+
$ cargo install newdoc
57
59
```
58
60
59
-
* To update `newdoc` from source, use the `cargo` package manager:
61
+
* To update `newdoc` from Docker, use the `docker` or `podman` tool:
0 commit comments