Skip to content

Commit

Permalink
fix: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michele Mondelli committed Aug 5, 2022
1 parent beba236 commit 0f25ae8
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,48 @@ Example project to develop application with [Java](https://www.java.com/) using

The idea is that you can use docker to develop your java application, without having to install anything on your system.

If you prefix your commands with the `c` wrapper you can run anything in the container like you use to do if you have maven and java installed on your system.
If you prefix your commands with `memento docker cmd` you can run anything in the container like you use to do if you have maven and java installed on your system.

## TL;DR

Run the `configure` script.
Install [Memento](https://github.com/bmeme/memento) and the [Memento Docker plugin](https://github.com/bmeme/memento-docker).
Then run:
```bash
./configure
memento docker configure
```

On the first run, it will ask some questions and set up for you the `.env` file.
Once this quick configuration is done, the help is shown.

To create the docker environment needed to work with your project, run:
```bash
./configure create
```

When the docker environment is up and running, you need to set your PATH to let it find the `c` wrapper.
```bash
eval $(./configure env)
memento docker configure create
```

All done!

Check that everything is working well by running some test commands:

```bash
c mvn --version
memento docker cmd mvn --version
```

```bash
c java -version
memento docker cmd java -version
```

## Access the container

You can use the `c` wrapper to exec commands in the container.
You can run a shell directly inside the container:

```
c bash
```bash
memento docker cmd bash
```

## References

- [BMEME](https://www.bmeme.com)
- [Memento](https://github.com/bmeme/memento)
- [Memento Kickstarter plugin](https://github.com/bmeme/memento-kickstarter)
- [Memento Docker plugin](https://github.com/bmeme/memento-docker)

0 comments on commit 0f25ae8

Please sign in to comment.