Update README.md

README.md

@@ -1,5 +1,32 @@
 # dungeon-pipeline
 
+An OS-agnostic, portable, extensible 3D pipeline for the BYU Center for Animation's 2025 Capstone film, *Love & Dungeons*.
+
+`dungeon-pipeline` is currently being used on EL8 and Windows 10 systems. It should also be functional on macOS systems, but that has not been tested.
+
+## Repo structure
+```
+dungeon-pipeline/
+├── Dungance Painter.lnk  # Linux and Windows launchers for DCCs. 
+├── Dungaya.desktop       # These are at the root so they're easy for artists to locate
+├── ...
+├── LICENSE
+├── pipeline
+│   ├── env.py.md         # How to build set up env.py
+│   ├── lib               # Python libraries and other resource files
+│   ├── __main__.py
+│   ├── pipe              # Python module for code that is imported and run from the DCC
+│   ├── shared            # Utilities used by `pipe` and `software` modules
+│   └── software          # Module called by `__main__.py` to initialize environments and launch DCCs
+├── pyproject.toml
+└── README.md
+```
+
+## Setting up a copy of `dungeon-pipeline`
+1. Fork this repo and clone it to the production location.
+1. Create an `pipeline/env.py` file following the specifications in `pipeline/env.py.md`. This will get things like ShotGrid auth set up, and provide OS-specific DCC executable paths.
+1. Install needed python libraries into `pipeline/lib/python/any`. (This will soon by managed via Poetry (Issue #137), for now see the list in `.githooks/setup-venv.sh`).
+1. Clone branches for development locally, copy over the env files and get to work!
 
 ## Setting up a dev environment in the labs
 1. Generate a GitHub SSH key and upload it to your GitHub