From 12daddedd87ac0aa576f314f98d8a7d8f131717d Mon Sep 17 00:00:00 2001 From: Ignacio Van Droogenbroeck <64545348+xe-nvdk@users.noreply.github.com> Date: Mon, 23 Nov 2020 17:36:59 -0300 Subject: [PATCH 1/4] Update readme.md --- README.md | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 60124d5..01dc64c 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,21 @@ # EZCompose ![visitors](https://visitor-badge.glitch.me/badge?page_id=ezcompose) ![Pylint](https://github.com/xe-nvdk/ezcompose/workflows/Pylint/badge.svg) -EZCompose es un programa en Python que mediante un asistente te ayuda a generar un archivo docker-compose.yml. En este video, pueden ver [cómo funciona EZCompose](https://youtu.be/nCqUx_3D7mQ?t=100). +EZCompose is a docker-compose.yml builder. Define your images, networks, volumes, ports and more, easily. In this video (Spanish) you can see how [EZCompose works](https://youtu.be/nCqUx_3D7mQ?t=100). -## Preguntas Frecuentes +## FAQ -### Como ejecuto EZCompose - -Para ejecutar EZCompose, si estás en Linux, descargas el ejecutable que encontrarás en [releases](https://github.com/xe-nvdk/ezcompose/releases), si no quieres ejecutarlo desde el ejecutable y quieres lanzar el script de Python, usa el que esta especificado en el release, ya que el de repositorio se esta tocando todo el tiempo y puede no funcionar. - -Si usas código fuente descargado desde el release, necesitas instalar Python3 en tu sistema, Si no lo tienes, ejecutas: +### How I should run EZCompose? +In each release, you have a executable file to run EZCompose under Linux or MacOS. ``` -$ sudo apt-get install python3 +$ ./ezcompose ``` -Si estás en Windows, te recomiendo que lo bajes desde la [página oficial](https://www.python.org/downloads/). +If you're a Windows user, you need to download the source code and run in the following way. -Una vez que instalaste, descargas la última versión de EZCompose y ejecutas lo siguiente: ``` python3 ezcompose.py ``` -A partir de ahí, deberías ver la pantalla de bienvenida - -``` -############################################################## -################ Bienvenides a EZCompose ##################### -############################################################## - -Este programa te ayudará a crear un archivo docker-compose.yml - -Escribe el nombre del servicio: -``` -### Le faltan opciones a EZCompose - -Si, eso es correcto, a la fecha que estoy escribiendo esto, (Noviembre 2020) EZCompose es capaz de generar un archivo docker-compose.yml totalmente funcional, pero es bastante limitado, solo podés agregar un solo juego de puertos, un solo volumen, una sola label, etc. La idea es que a medida que siga aprendiendo Python, tenga más funcionalidades y alcance un grado "Production Ready". +If you don't have installed Python, you can download it from [[here](https://www.python.org/downloads/). -### Che, me gustaría contribuir +### I want to contribute with EZCompose -Si te copa el proyecto y te gustaría contribuir, ningún problema, todas las contribuciones son bienvenidas. Simplemente hace un Fork de este repo y cuando tengas esa modificación hecha, hace un Pull Request. +If you like this project and you want to contribute, you're very welcome to do it, just fork it and make a pull request when you're ready. Here, you can see the the [To Do list](https://github.com/xe-nvdk/ezcompose/projects/1) and here the [Issues]https://github.com/xe-nvdk/ezcompose/issues). From 99ad5f53015b813793fe79a74246e2e9c1b80c4b Mon Sep 17 00:00:00 2001 From: Ignacio Van Droogenbroeck <64545348+xe-nvdk@users.noreply.github.com> Date: Mon, 23 Nov 2020 17:37:43 -0300 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01dc64c..ed8ae71 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ EZCompose is a docker-compose.yml builder. Define your images, networks, volumes ## FAQ -### How I should run EZCompose? +### How should I run EZCompose? In each release, you have a executable file to run EZCompose under Linux or MacOS. ``` From c5cc529804627a7c00dba12b0dea9477f43771bb Mon Sep 17 00:00:00 2001 From: Ignacio Van Droogenbroeck <64545348+xe-nvdk@users.noreply.github.com> Date: Mon, 23 Nov 2020 17:38:06 -0300 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed8ae71..49e4428 100644 --- a/README.md +++ b/README.md @@ -18,4 +18,4 @@ If you don't have installed Python, you can download it from [[here](https://www ### I want to contribute with EZCompose -If you like this project and you want to contribute, you're very welcome to do it, just fork it and make a pull request when you're ready. Here, you can see the the [To Do list](https://github.com/xe-nvdk/ezcompose/projects/1) and here the [Issues]https://github.com/xe-nvdk/ezcompose/issues). +If you like this project and you want to contribute, you're very welcome to do it, just fork it and make a pull request when you're ready. Here, you can see the the [To Do list](https://github.com/xe-nvdk/ezcompose/projects/1) and here the [Issues](https://github.com/xe-nvdk/ezcompose/issues). From 50e5a73c09ee5600015fbf966345537236942a9d Mon Sep 17 00:00:00 2001 From: Ignacio Van Droogenbroeck <64545348+xe-nvdk@users.noreply.github.com> Date: Mon, 23 Nov 2020 17:42:37 -0300 Subject: [PATCH 4/4] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49e4428..707a649 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,15 @@ $ ./ezcompose If you're a Windows user, you need to download the source code and run in the following way. ``` -python3 ezcompose.py +$ python3 ezcompose.py ``` If you don't have installed Python, you can download it from [[here](https://www.python.org/downloads/). +Since the v0.1.5, EZCompose can be run from a Docker Container, you only need to run... +``` +$ docker run -it hectorivand/ezcompose:v0.1.5 +``` + ### I want to contribute with EZCompose If you like this project and you want to contribute, you're very welcome to do it, just fork it and make a pull request when you're ready. Here, you can see the the [To Do list](https://github.com/xe-nvdk/ezcompose/projects/1) and here the [Issues](https://github.com/xe-nvdk/ezcompose/issues).