Skip to content

Commit

Permalink
Lint README
Browse files Browse the repository at this point in the history
  • Loading branch information
protocol7 committed Jul 28, 2019
1 parent b517a2d commit 2701561
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,22 @@ Windows should be doable.
### Using git

```
$ git clone https://github.com/protocol7/javaenv.git ~/.javaenv
git clone https://github.com/protocol7/javaenv.git ~/.javaenv
```

`javaenv` is a self-contained script and requires Python 3.3 or newer to run.

For convenience, add `javaenv` to your $PATH, e.g. using:

```
$ ln -s ~/.javaenv/javaenv /usr/local/bin
ln -s ~/.javaenv/javaenv /usr/local/bin
```

Shim the Java command line tools:

```
$ ln -s ~/.javaenv/javaenv /usr/local/bin/java
$ ln -s ~/.javaenv/javaenv /usr/local/bin/javac
ln -s ~/.javaenv/javaenv /usr/local/bin/java
ln -s ~/.javaenv/javaenv /usr/local/bin/javac
...
```

Expand Down Expand Up @@ -65,7 +64,6 @@ The version can for some commands and for `.javaversion` files exclude the
distribution, in which case `openjdk` is used as the default. Thus, a valid
version can also be, for example, `11.0.2`.


### .javaversion

If a version is not provided for a command, or when calling Java command line
Expand All @@ -74,7 +72,7 @@ current directory. This file should contain only the version, as defined above,
for example:

```
$ echo 'openjdk-11.0.2' > .javaversion
echo 'openjdk-11.0.2' > .javaversion
```

It is recommended that `.javaversion` is kept under version control with your
Expand Down Expand Up @@ -111,7 +109,7 @@ be provided to the command, or read from a `.javaversion file`. The command is
useful when setting `JAVA_HOME` for tools using it, e.g. Maven.

```
$ export JAVA_HOME=$(javaenv home)
export JAVA_HOME=$(javaenv home)
```

## Verification of installations
Expand All @@ -122,8 +120,8 @@ so this requires you to trust your javaenv installation.

## TODO

* Add support for automatically shimming Java command line tools
* Add all released and still available versions
* Add support for Linux
* Add support for building Docker images
* Add direct support for setting Java version for Maven
* Add support for automatically shimming Java command line tools
* Add all released and still available versions
* Add support for Linux
* Add support for building Docker images
* Add direct support for setting Java version for Maven

0 comments on commit 2701561

Please sign in to comment.