From f0f00bf9c956a53fd2caee18d5c07eb09fcbc16e Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Wed, 15 May 2024 13:45:15 -0700 Subject: [PATCH] updating readme and changelog --- CHANGELOG.md | 2 +- README.md | 5 +++-- environment.yml | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14be871..3fc3f1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [UNRELEASED] - XXXX.XX.XX +## [v0.6.0] - 2024.05.15 ### Added diff --git a/README.md b/README.md index 5ce62a5..a7ae17d 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,9 @@ To install this package, run: ```bash cd spacegym-kspdg -pip install -e . +pip install -e . +# if you plan to further develop the kspdg package, install the testing optional dependencies +# pip install -e .[testing] ``` For development of this package, we recommend using the conda environment defined in `environment.yml`. To create and activate this environment, run: @@ -205,7 +207,6 @@ _Future Work_ ### Verify Installation -__TODO:__ Update install instructions to reflect testing w/ new `pyproject.toml` and `optional-dependencies` __NOTE:__ Because the KSPDG environments are inexorably linked to the KSP game engine, many of the library's unit/integration test can only be run when a particular game mission file has been loaded and running. This means that verifying installation and testing during code development is a bit more involved than just a single `pytest` call __Serverless Tests:__ Quick test to run without KSP game engine running nor kRPC server connection diff --git a/environment.yml b/environment.yml index 98c3d54..1707770 100644 --- a/environment.yml +++ b/environment.yml @@ -6,4 +6,4 @@ dependencies: - ipython - pip - pip: - - -e . + - -e .[testing] # install developer dependencies