From 092131e4ca256c39d00e198651909782273295be Mon Sep 17 00:00:00 2001 From: jpt Date: Sun, 20 Apr 2025 00:07:56 -0500 Subject: [PATCH] README updates --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 466b1ab..03b1b6e 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,25 @@ This is our opinionated template for starting new Django projects. It adds a few libraries useful for every Django project, with reasonable starting configurations. Additionally, the repository has linting/CI rules and a project layout that has worked well for our many Django projects. -## License +## License & Usage This project is placed into the public domain ([CC0](https://creativecommons.org/public-domain/cc0/)) so you may use it however you see fit. -You can clone this repository, use it as a template, or pick & choose what you like. Attribution is appreciated but not required. +You can clone this repository and use it as a template, or pick & choose what you like and copy files as needed. + +Attribution is appreciated but not required. Please note that the underlying libraries are under their own (MIT/BSD) licenses. ## Getting Started +To make full usage of this you will need to install + +- `uv` - +- `just` + - You can run `just` using `uv` if you wish, `uvx --from rust-just just` + + If you are using this library as a baseline, there are a few steps you'll need to follow: 1. Read through the various sections below to familiarize yourself with the setup.