From b3f24f807da4bce3b1d37d92b530f44fed1b9131 Mon Sep 17 00:00:00 2001 From: Takeshi Kimata <117462761+kimatata@users.noreply.github.com> Date: Sun, 28 Jul 2024 15:24:22 +0900 Subject: [PATCH] docs: update --- README.md | 17 +++++++++++++++++ docs/docs/getstarted/docker.md | 1 + 2 files changed, 18 insertions(+) diff --git a/README.md b/README.md index 596e569..93bd80d 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,23 @@ UnitTCMS is an open source test case management system. The application is free [📘Docs](https://kimatata.github.io/unittcms/docs) +## Getting Started + +```bash +git clone https://github.com/kimatata/unittcms.git +``` + +and start containers with the following command. + +```bash +cd unittcms +docker-compose up --build +``` + +You can access the app at `http://localhost:8000` + +[Looking for a non-Docker way?](https://kimatata.github.io/unittcms/docs/getstarted/manual) + ## Features ### Project-Based diff --git a/docs/docs/getstarted/docker.md b/docs/docs/getstarted/docker.md index cfd90a7..9c9b5fc 100644 --- a/docs/docs/getstarted/docker.md +++ b/docs/docs/getstarted/docker.md @@ -13,6 +13,7 @@ git clone https://github.com/kimatata/unittcms.git and start containers with the following command. ```bash +cd unittcms docker-compose up --build ```