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.rst
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,29 +16,29 @@ With Docker installed there are two Docker images that you can use:
16
16
17
17
To fetch the developer image use the following command::
18
18
19
-
docker pull hsorby/libcellml-dev:0.1.5
19
+
docker pull libcellml/build:1.0.0
20
20
21
21
To fetch the documentation image use the following command::
22
22
23
-
docker pull hsorby/libcellml-docs:0.1.1
23
+
docker pull libcellml/docs:1.0.0
24
24
25
25
You may also pull the `latest` version of the images with the following commands::
26
26
27
-
docker pull hsorby/libcellml-dev
28
-
docker pull hsorby/libcellml-docs
27
+
docker pull libcellml/build
28
+
docker pull libcellml/docs
29
29
30
30
Running developer image
31
31
=======================
32
32
33
33
::
34
34
35
-
docker run hsorby/libcellml-dev https://github.com/cellml/libcellml develop
35
+
docker run libcellml/build https://github.com/cellml/libcellml develop
36
36
37
37
This will clone, build, and run the unit tests, code coverage, clang-format, and memory checking targets.
38
38
39
39
You can also build and run the tests from a local directory on the Docker daemon host computer. This can be achieved with the following command::
40
40
41
-
docker run --mount type=bind,src=<your-local-directory>,dst=/external/drive,readonly hsorby/libcellml-dev /external/drive
41
+
docker run --mount type=bind,src=<your-local-directory>,dst=/external/drive,readonly libcellml/build /external/drive
42
42
43
43
Hopefully it goes without saying that you need to replace `<your-local-directory>` with the actual directory where the libCellML code you wish to build and test exists.
44
44
@@ -53,11 +53,11 @@ Note: The debug mode option must be used in conjunction with '-it' flags for the
53
53
Some examples of using the command line options::
54
54
55
55
# Build serially
56
-
docker run hsorby/libcellml-dev https://github.com/cellml/libcellml develop -s
56
+
docker run libcellml/build https://github.com/cellml/libcellml develop -s
57
57
# Just build libraries and tests
58
-
docker run hsorby/libcellml-dev https://github.com/cellml/libcellml develop -b
58
+
docker run libcellml/build https://github.com/cellml/libcellml develop -b
59
59
# Enter a bash shell at the end of the build
60
-
docker run -it hsorby/libcellml-dev https://github.com/cellml/libcellml develop -d
60
+
docker run -it libcellml/build https://github.com/cellml/libcellml develop -d
61
61
62
62
From the command at the top of this section you should get output similar to what is shown in `Appendix A`_
63
63
@@ -66,13 +66,13 @@ Running documentation image
66
66
67
67
::
68
68
69
-
docker run -p 8118:8000 hsorby/libcellml-docs https://github.com/cellml/libcellml develop
69
+
docker run -p 8118:8000 libcellml/docs https://github.com/cellml/libcellml develop
70
70
71
71
This will clone, and build the documentation for libCellML and make the documentation available at `localhost:8118 <http://localhost:8118/>`_.
72
72
73
73
You can also build and serve documentation from a local directory. The documentation will be automatically built and reflected in a webbrowser when any documentation related changes are saved. This gives you a live rendering of the current state of the libCellML documentation. This can be achieved with the following command::
74
74
75
-
docker run --mount type=bind,src=<your-local-directory>,dst=/external/drive,readonly -p 8118:8000 hsorby/libcellml-docs /external/drive
75
+
docker run --mount type=bind,src=<your-local-directory>,dst=/external/drive,readonly -p 8118:8000 libcellml/docs /external/drive
76
76
77
77
Hopefully it goes without saying that you need to replace `<your-local-directory>` with the actual directory where the libCellML code you wish to render the documentation for exists.
0 commit comments