From fa957bc22f71c340ffdd94708e7f8734acc01017 Mon Sep 17 00:00:00 2001 From: Bhautik Date: Sun, 13 Mar 2022 04:10:25 +0000 Subject: [PATCH 1/2] docs(bhtk/readme-change): removed unwanted bullets --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 42f1996..588232a 100644 --- a/README.md +++ b/README.md @@ -153,4 +153,3 @@ As an alternative, you can create a `dockerized.env` file in the current directo - It's not currently possible to access parent directories. (i.e. `dockerized tree ../dir` will not work) - Workaround: Execute the command from the parent directory. (i.e. `cd .. && dockerized tree dir`) - Commands will not persist changes outside the working directory, unless specifically supported by `dockerized`. -- From f8404cb167696e12e7b4736c0eb74333e68feee5 Mon Sep 17 00:00:00 2001 From: Bhautik Date: Sun, 13 Mar 2022 05:38:25 +0000 Subject: [PATCH 2/2] docs(bhtk/readme-change): rename readme files, and update instructions --- README.md | 11 +++++++++-- apps/aws/{Readme.md => README.md} | 0 apps/doctl/{Readme.md => README.md} | 0 apps/dotnet/{Readme.md => README.md} | 0 apps/gh/{Readme.md => README.md} | 0 apps/npm/{Readme.md => README.md} | 0 apps/s3cmd/{Readme.md => README.md} | 0 7 files changed, 9 insertions(+), 2 deletions(-) rename apps/aws/{Readme.md => README.md} (100%) rename apps/doctl/{Readme.md => README.md} (100%) rename apps/dotnet/{Readme.md => README.md} (100%) rename apps/gh/{Readme.md => README.md} (100%) rename apps/npm/{Readme.md => README.md} (100%) rename apps/s3cmd/{Readme.md => README.md} (100%) diff --git a/README.md b/README.md index 588232a..852fd28 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,16 @@ dockerized ## Installation -- Install [Docker](https://docs.docker.com/get-docker/) -- Clone this repo anywhere: `git clone git@github.com:datastack-net/dockerized.git` +- Make sure [Git](https://git-scm.com/downloads), and [Docker](https://docs.docker.com/get-docker/) has installed on your machine. +- Clone this repo anywhere by using + ```shell + git clone git@github.com:datastack-net/dockerized.git + ``` - Add the `bin` directory to your path + ```bash + # In the linux systems + export PATH=$PATH:`pwd`/bin + ``` ## Usage diff --git a/apps/aws/Readme.md b/apps/aws/README.md similarity index 100% rename from apps/aws/Readme.md rename to apps/aws/README.md diff --git a/apps/doctl/Readme.md b/apps/doctl/README.md similarity index 100% rename from apps/doctl/Readme.md rename to apps/doctl/README.md diff --git a/apps/dotnet/Readme.md b/apps/dotnet/README.md similarity index 100% rename from apps/dotnet/Readme.md rename to apps/dotnet/README.md diff --git a/apps/gh/Readme.md b/apps/gh/README.md similarity index 100% rename from apps/gh/Readme.md rename to apps/gh/README.md diff --git a/apps/npm/Readme.md b/apps/npm/README.md similarity index 100% rename from apps/npm/Readme.md rename to apps/npm/README.md diff --git a/apps/s3cmd/Readme.md b/apps/s3cmd/README.md similarity index 100% rename from apps/s3cmd/Readme.md rename to apps/s3cmd/README.md