Skip to content

Commit

Permalink
updating readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
rallen10 committed May 15, 2024
1 parent ab9dec7 commit f0f00bf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dependencies:
- ipython
- pip
- pip:
- -e .
- -e .[testing] # install developer dependencies

0 comments on commit f0f00bf

Please sign in to comment.