Skip to content

Edits and revisions to README-content.md and README-short.txt #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions java/README-content.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,43 @@
# 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.

> [wikipedia.org/wiki/Java_(programming_language)](http://en.wikipedia.org/wiki/Java_(programming_language))

# 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
WORKDIR /usr/src/myapp
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
3 changes: 2 additions & 1 deletion java/README-short.txt
Original file line number Diff line number Diff line change
@@ -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.