aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-09-03 21:18:11 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-09-03 21:18:11 +0100
commit3239fc6037199e28b54fbe104b082a9bd13b6ad9 (patch)
tree9b54fa586bead68bf2c0d38f5e21adbb84eb451b /README.md
parent621d71e03bc66b89e9dc5d6acc8c37b403adc8a2 (diff)
parent6d18576568da8298295c82c0853057d7ea5e8b61 (diff)
Imported recent work in Maneage, minor conflicts fixed
Only two small conflicts came up: * The addition of the hardware architecture macro in 'paper.tex' (which was removed for now, but will be added as the referee has requested within the text). * The usage of "" around directory variables in 'paper.mk'.
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 24 insertions, 12 deletions
diff --git a/README.md b/README.md
index 748a791..24e12d8 100644
--- a/README.md
+++ b/README.md
@@ -249,21 +249,18 @@ MB), not the full TeXLive collection!
```
2. **Maneage dependencies:** By default the "slim" versions of the
- operating systems don't contain a compiler, so you need to use the
- selected operating system's package manager to import them. You can
- optionally install two other programs: 1) To inspect/edit the project's
- source files later, install your favorite text editor. 2) If you don't
- have the project's software tarballs, and want the project to download
- them automatically, you also need a downloader.
+ operating systems don't contain a compiler (needed by Maneage to
+ compile precise versions of all the tools). You thus need to use the
+ selected operating system's package manager to import them (below is
+ the command for Debian). Optionally, if you don't have the project's
+ software tarballs, and want the project to download them automatically,
+ you also need a downloader.
```shell
# C and C++ compiler.
RUN apt-get update && apt-get install -y gcc g++
- # Uncomment this to add a text editor (to modify source files later).
- #RUN apt-get install -y nano
-
- # Uncomment this if you don't have 'software-XXXX.tar.gz'
+ # Uncomment this if you don't have 'software-XXXX.tar.gz' (below).
#RUN apt-get install -y wget
```
@@ -348,10 +345,14 @@ MB), not the full TeXLive collection!
7. **Build the Docker image:** The `Dockerfile` is now ready! In the
terminal, go to its directory and run the command below to build the
- Docker image. Just set a `NAME` for your project and note that Docker
- only runs as root.
+ Docker image. We recommend to keep the `Dockerfile` in **an empty
+ directory** and run it from inside that directory too. This is because
+ Docker considers that directories contents to be part of the
+ environment. Finally, just set a `NAME` for your project and note that
+ Docker only runs as root.
```shell
+ sudo su
docker build -t NAME ./
```
@@ -407,6 +408,17 @@ docker container list
docker commit XXXXXXX NEW-IMAGE-NAME
```
+#### Copying files from the Docker image to host operating system
+
+The Docker environment's file system is completely indepenent of your host
+operating system. One easy way to copy files to and from an open container
+is to use the `docker cp` command (very similar to the shell's `cp`
+command).
+
+```shell
+docker cp CONTAINER:/file/path/within/container /host/path/target
+```
+