From 9a0d968cde844304acc6c48f107184b71ce304fc Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Tue, 25 Aug 2020 23:03:01 +0100 Subject: README.md: added explanation on copying files from Docker image When building Maneage inside a Docker container, in the end the users want to extract the final outputs from the container into their host operating system to inspect more comfortably. So with this commit, a short examplanation has been added on how to do this. We also noticed that it is much better if the 'Dockerfile' is stored and run in an empty directory, otherwise, it will start parsing the full directory and its subdirectories as the docker image's environment. --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 174e084..383dbc1 100644 --- a/README.md +++ b/README.md @@ -343,10 +343,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 ./ ``` @@ -402,6 +406,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 +``` + -- cgit v1.2.1 From 6d18576568da8298295c82c0853057d7ea5e8b61 Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Fri, 28 Aug 2020 16:10:27 +0100 Subject: Edited README.md to remove installation of a text editor With the previous commit, we now build Nano by default within Maneage, and project authors can ask to install Emacs and Vim within 'TARGETS.conf'. So in the instructions to build within a Docker image have been removed. --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 383dbc1..aadfcef 100644 --- a/README.md +++ b/README.md @@ -244,21 +244,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 ``` -- cgit v1.2.1