From c6a087933688a8384365eb6ba84818320f9e77ff Mon Sep 17 00:00:00 2001
From: "J.P. Hutchins" <jphutchins@gmail.com>
Date: Wed, 14 Feb 2024 10:14:56 -0800
Subject: [PATCH] docs: development README

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/README.md b/README.md
index 20cb78d..f15d736 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,69 @@
 # Simple Management Protocol (SMP)
+
+`smp` implements serialization and deserialization of the Simple Management Protocol.
+
+The SMP specification can be found [here](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_protocol.html).
+
+## Install
+
+`smp` is [distributed by PyPI](https://pypi.org/project/smp/) and can be installed with `poetry`, `pip`, and other dependency managers.
+
+## Development Quickstart
+
+> Assumes that you've already [setup your development environment](#development-environment-setup).
+
+1. activate [envr](https://github.com/JPhutchins/envr), the environment manager for **bash**, **zsh**, and **PS**:
+   ```
+   . ./envr.ps1
+   ```
+2. run `poetry install` when pulling in new changes
+3. run `lint` after making changes
+4. run `test` after making changes
+5. add library dependencies with `poetry`:
+   ```
+   poetry add <my_new_dependency>
+   ```
+6. add test or other development dependencies using [poetry groups](https://python-poetry.org/docs/managing-dependencies#dependency-groups):
+   ```
+   poetry add -G dev <my_dev_dependency>
+   ```
+
+## Development Environment Setup
+
+### Install Dependencies
+
+- python >=3.10, <3.13
+- poetry: https://python-poetry.org/docs/#installation
+
+### Create the venv
+
+```
+poetry install
+```
+
+The `venv` should be installed to `.venv`.
+
+### Activate envr
+
+> [envr](https://github.com/JPhutchins/envr) supports **bash**, **zsh**, and **PS** in Linux, MacOS, and Windows.  If you are using an unsupported shell, you can activate the `.venv` environment manually, use `poetry run` and `poetry shell`, and refer to `envr-default` for useful aliases.
+
+```
+. ./envr.ps1
+```
+
+### Verify Your Setup
+
+To verify the installation, make sure that all of the tests are passing using these envr aliases:
+
+```
+lint
+test
+```
+
+### Enable the githooks
+
+> The pre-commit hook will run the linters but not the unit tests.
+
+```
+git config core.hooksPath .githooks
+```