Skip to content

Commit 34e39e7

Browse files
author
Marek Suchánek
authored
Warn about a known issue with the container
1 parent 65c2e58 commit 34e39e7

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,26 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
2323
2424
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.
2525
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:
2727
2828
```
29-
$ docker pull mrksu/newdoc
29+
$ cargo install newdoc
3030
31-
$ docker run mrksu/newdoc
31+
$ newdoc
3232
```
3333
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:
3637
3738
```
38-
$ cargo install newdoc
39+
$ docker pull mrksu/newdoc
3940
40-
$ newdoc
41+
$ docker run mrksu/newdoc
4142
```
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).
4245
43-
For installing `cargo`, see <https://rustup.rs/>.
4446
4547
## Updating newdoc
4648
@@ -50,16 +52,16 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
5052
# dnf upgrade newdoc
5153
```
5254
53-
* To update `newdoc` from Docker, use the `docker` or `podman` tool:
55+
* To update `newdoc` from source, use the `cargo` package manager:
5456
5557
```
56-
$ docker pull mrksu/newdoc
58+
$ cargo install newdoc
5759
```
5860
59-
* To update `newdoc` from source, use the `cargo` package manager:
61+
* To update `newdoc` from Docker, use the `docker` or `podman` tool:
6062
6163
```
62-
$ cargo install newdoc
64+
$ docker pull mrksu/newdoc
6365
```
6466
6567

0 commit comments

Comments
 (0)