jpt/djok
Template
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

README updates

Browse Source
This commit is contained in:
jpt 2025-04-20 00:07:56 -05:00
parent 5c197364b5
commit 092131e4ca
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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. 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. 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. 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. Please note that the underlying libraries are under their own (MIT/BSD) licenses.
## Getting Started ## Getting Started
To make full usage of this you will need to install
- `uv` - <https://docs.astral.sh/uv/getting-started/installation/>
- `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: 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. 1. Read through the various sections below to familiarize yourself with the setup.