From 0f25ae83ee7fc819fd7ebf99da51a3e8392da1ea Mon Sep 17 00:00:00 2001 From: Michele Mondelli Date: Fri, 5 Aug 2022 12:00:32 +0200 Subject: [PATCH] fix: update README --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e507859..45601c0 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,14 @@ 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. @@ -18,12 +19,7 @@ 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! @@ -31,22 +27,25 @@ 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)