From c17b68e6ac58fb691a51a1ef32162b7800cc8999 Mon Sep 17 00:00:00 2001 From: Fred Lifton Date: Thu, 11 Sep 2014 20:32:30 -0700 Subject: [PATCH] Edits and revisions to README-content.md and README-short.txt --- java/README-content.md | 23 ++++++++++++++++------- java/README-short.txt | 3 ++- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/java/README-content.md b/java/README-content.md index b2571dced3e7..210322d1f602 100644 --- a/java/README-content.md +++ b/java/README-content.md @@ -1,6 +1,9 @@ # What is Java? -Java is a concurrent, class-based, object-oriented language specifically designed to have as few implementation dependencies as possible. It is intended to allow application developers to "write once, run anywhere", meaning that code that runs on one platform does not need to be recompiled to run on another. +Java is a concurrent, class-based, object-oriented language specifically designed to have +as few implementation dependencies as possible. It is intended to allow application +developers to "write once, run anywhere", meaning that code that runs on one platform +does not need to be recompiled to run on another. Java is a registered trademark of Oracle and/or its affiliates. @@ -8,9 +11,12 @@ Java is a registered trademark of Oracle and/or its affiliates. # How to use this image -## Start a java instance running your app +## Start a Java instance in your app + +The most straightforward way to use this image is to use a Java container as both the ++build and runtime environment. In your `Dockerfile`, writing something along the lines ++of the following will compile and run your project. -For this image, the most straight-forward use is to use a java container as both the build environment as well as the runtime environment. In your Dockerfile, you can do something along the lines of the following will compile and run your project. FROM java:7 COPY . /usr/src/myapp @@ -18,17 +24,20 @@ For this image, the most straight-forward use is to use a java container as both RUN javac Main.java CMD ["java", "Main"] -Then run the commands to build and run the docker image. +You can then run and build the Docker image. docker build -t my-java-app . docker run -it --rm --name my-running-app my-java-app -## Compile your app inside the docker container. +## Compile your app inside the Docker container. -It is not always appropriate to run your app inside a container. In instances where you only want to compile inside the docker instance, you can do something along the lines of the following. +There may be occasions where it is not appropriate to run your app inside a container. To ++compile, but not run your app inside the Docker instance, you can write something like: docker run --rm -v "$(pwd)":/usr/src/myapp -w /usr/src/myapp java:7 javac Main.java -This will add your current directory as a volume to the container, set the working directory to the volume, and run the command `javac Main.java` which will tell java to compile the code in Main.java and output the java class file to Main.class. Alternatively, if you have a make file, you can instead run the make command inside your container. +This will add your current directory as a volume to the container, set the working ++directory to the volume, and run the command `go build` which will tell Java to compile the code in `Main.java` and output the Java class file to `Main.class`. Alternatively, if ++you have a make file, you can run the `make` command inside your container. docker run --rm -v "$(pwd)":/usr/src/myapp -w /usr/src/myapp java:7 make diff --git a/java/README-short.txt b/java/README-short.txt index d094804cd045..1dff6d3be153 100644 --- a/java/README-short.txt +++ b/java/README-short.txt @@ -1 +1,2 @@ -Java is a computer programming language that is concurrent, class-based, object-oriented, and specifically designed to have as few implementation dependencies as possible. +Java is a computer programming language that is concurrent, class-based, object-oriented, +and specifically designed to have as few implementation dependencies as possible.