From e2dcf0bf50945f75f953044e271261ea1f208eab Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Wed, 27 Mar 2024 10:46:52 -0400 Subject: [PATCH] Adds quickstart instructions to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ab0982a..968a252 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,17 @@ This repository contains a simple Python® project setup using the Make Python DevEx system described and built by Colin Dean. +> [!TIP] +> **Quickstart:** With [Homebrew](https://brew.sh) installed and `brew` available (`which brew`): +> ```bash +> # if you use the gh CLI tool +> gh repo clone target/make-python-devex +> # or just git +> git clone https://github.com/target/make-python-devex.git +> # then set it up, run deps twice in separate invocations +> make deps +> make deps check test build + Run `make help` to see the tasks available. In theory, run `make deps` until it succeeds, following any instructions output