From 665cba601d06c947644e08cbed825cec2636774f Mon Sep 17 00:00:00 2001 From: Reut Sharabani Date: Tue, 26 Dec 2023 22:46:36 +0200 Subject: [PATCH] move to folder + add entry in README.md --- README.md | 15 +++++++++++++++ Dockerfile => docker/Dockerfile | 3 --- 2 files changed, 15 insertions(+), 3 deletions(-) rename Dockerfile => docker/Dockerfile (55%) diff --git a/README.md b/README.md index e164474..32d3779 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,21 @@ Ubuntu 18.04 On OSX and Windows it is required to build DicomToMesh yourself. +### Using via Docker + +There is a [docker file](docker/Dockerfile) ready for use. If you have docker installed you can use the generated image without installing anything locally. + +#### Usage + +```bash +# build image and tag it as `dicom2mesh` +docker build docker -t dicom2mesh +# use generated image to build an stl file +docker run -v `pwd`/my/dicom/files/:/data dicom2mesh -i /data -t 557 -o /data/mesh.stl +``` + +Your mesh will be created alongside your dicom images and named `mesh.stl` + # Building The software is written in modern C++ on top of the powerful VTK library and is using CMake as a build-system. diff --git a/Dockerfile b/docker/Dockerfile similarity index 55% rename from Dockerfile rename to docker/Dockerfile index 1ab6c69..6ed5390 100644 --- a/Dockerfile +++ b/docker/Dockerfile @@ -7,6 +7,3 @@ RUN apt update RUN apt install -y dicom2mesh ENTRYPOINT ["dicom2mesh"] -# use like so: -# docker run -v `pwd`/my/dicom/files/:/data dicom2mesh -i /data -t 557 -o /data/mesh.stl -# your mesh will be alongside your dicom images