From 824dc77e38666859d5af32609d87308c9181c541 Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Mon, 30 Dec 2024 16:37:40 -0800 Subject: [PATCH] updating install instructions --- CHANGELOG.md | 6 ++++++ README.md | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a0a81c..a37251c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ 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 + +### Fixed + ++ Instructions for installing from github to use `main` branch instead of `latest` + ## [v0.11.0] - 2024.12.16 ### Added diff --git a/README.md b/README.md index 40ecbd4..9f86e26 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ cp -r ~/Desktop/PhysicsRangeExtender/PhysicsRangeExtender/Distribution/GameData/ Light-weight installation with limited functionality ```bash # pip install minimal kspdg package -pip install kspdg@git+https://github.com/mit-ll/spacegym-kspdg@latest +pip install kspdg@git+https://github.com/mit-ll/spacegym-kspdg@main # KSPDG mission save files, follow instructions for pointing to your KSP game installation kspdg-install-ksp-files @@ -187,7 +187,7 @@ kspdg-install-ksp-files Full installation with private-source environments that depend on Julia ```bash # pip install full kspdg package -pip install kspdg@git+https://github.com/mit-ll/spacegym-kspdg@latest#egg=kspdg[full] +pip install kspdg@git+https://github.com/mit-ll/spacegym-kspdg@main#egg=kspdg[full] # Copy KSPDG mission save files and evaluation configs to your KSP game installation # follow instructions for pointing to your KSP game installation