Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds quickstart instructions to README #8

Merged
merged 1 commit into from
Apr 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading