From 866d52891d5794149b41616e1478370a98916d43 Mon Sep 17 00:00:00 2001 From: Skyler Lewis Date: Mon, 17 Sep 2018 11:46:41 -0600 Subject: [PATCH] adding docker for quickstart usage --- Dockerfile | 16 ++++++++++++++++ README.md | 9 +++++++++ 2 files changed, 25 insertions(+) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..1191589 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM ubuntu:bionic + +COPY . /root + +RUN apt-get update +RUN apt-get install -y git locales \ + && rm -rf /var/lib/apt/lists/* + +RUN echo "LC_ALL=en_US.UTF-8" >> /etc/environment \ + && echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen \ + && echo "LANG=en_US.UTF-8" > /etc/locale.conf \ + && locale-gen en_US.UTF-8 + +WORKDIR /app + +ENTRYPOINT bash /root/gh-jack $@ diff --git a/README.md b/README.md index e39ec70..5a96367 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,15 @@ Features - define the template position relatively (left, center,...) or absolutely (start date) - write the message into a repository file for each commit +Quickstart +---------- +Build the docker container. + + docker build -t ghjack . + +Run the docker container from the directory you want your commits to be. A new repo will be initialized for you if one does not exist. + + docker run -it --rm -v $(pwd):/app -v $HOME/.gitconfig:/root/.gitconfig ghjack -f -v Usage -----