Added license file

LICENSE.txt

@@ -0,0 +1,20 @@
+
+Copyright (c) [2022] [Zach Williams]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,6 @@
-# Distributed Potential- iterative Linear Quadratic Regulator (DP-iLQR)
+# *Distributed Potential-iterative Linear Quadratic Regulator (DP-iLQR)*
+
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Overview
 Repository containing code for a distributed implementation of [Potential
@@ -68,18 +70,18 @@ This should create a `bbdynamicswrap.cpp` as well as a `*.so` file that
 `dpilqr` will automatically include in the package namespace.
 
 ### Environment
-There are a few different python packages that this project relies on listed
-out in the next section. For convenience, there's also an
-[requirements.txt](requirements.txt) file that one can use to spin up an
-environment with all of the necessary dependencies. To create an environment 
-from this file, execute the following (from the top of the repo) (in unix):
+There are a few different python packages that this project relies on listed out in the
+next section. One can use the [requirements.txt](requirements.txt) to spin up an
+environment with all of the necessary dependencies. To do this, execute the following
+(from the top of the repo) (in unix):
 
     python -m venv env
     source env/bin/activate
     pip install requirements.txt
 
 
 ### Organization
+- [dpilqr](dpilqr) contains the project source code
 - [run/examples.py](run/examples.py) provides several examples that exercise many
   aspects of the library.
 - [run/analysis.py](run/analysis.py) contains scripts that run monte-carlo simulations

pyproject.toml

@@ -3,6 +3,9 @@ name = "Distributed Potential-iLQR"
 version = "0.1.0"
 description = "Implementation of Distributed Potential iLQR for scalable cooperative multi-agent navigation."
 authors = ["Zach Williams <[email protected]>", "Randy Chen <[email protected]>"]
+license = {file = "LICENSE.txt"}
+readme = "README.md"
+requires-python = ">=3.8"
 
 [tool.poetry.dependencies]
 python = "~3.10"