Skip to content

Commit

Permalink
Prep for 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
HebaruSan committed Feb 10, 2017
1 parent 1bbcfaa commit ccc41cc
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 32 deletions.
2 changes: 1 addition & 1 deletion Astrogator.version
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"VERSION": {
"MAJOR": 0,
"MINOR": 2,
"MINOR": 3,
"PATCH": 0,
"BUILD": 0
},
Expand Down
47 changes: 47 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Technical instructions

## Contributing

[Pull requests](https://github.com/HebaruSan/Astrogator/pulls) are welcome!

## Installation

### Manual

Unpack the [zip file](https://github.com/HebaruSan/Astrogator/releases) in your GameData folder.

### CKAN

```sh
mono ckan install Astrogator
```

## Compiling

### Linux (and maybe MacOS)

```sh
git clone [email protected]:HebaruSan/Astrogator.git
cd Astrogator
ln -s /path/to/KSP/KSP_x64_Data src
make
```

If you have KSP installed via Steam, you may be able to skip the `ln -s` step, as the Makefile attempts to find it in the standard location.

### Windows

I assume opening the `csproj` file in Visual Studio would work, but I haven't tried it.

## Packing a release

1. Commit all changes intended for release
1. Update [TODO list](TODO.md) to reflect changes
1. Update version in [AVC file](Astrogator.version)
1. Update version in [DLL assembly](src/Properties/AssemblyInfo.cs)
1. Commit and push to Github
1. Create a new release on Github
1. `make clean && make`
1. Attach zip file to Github release
1. Release the release
1. Watch CKAN for updates
31 changes: 2 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,38 +73,11 @@ Click the wrench to open and close the settings panel:

## Future plans

- Useful numbers for launches/landed
- Return-to-LKO burns from Mun and Minmus
- Capture burns for inbound hyperbolic orbits
- Reduce ejection burn by the amount the plane change burn adds to it (i.e., fix Minmus overshoots)
- Allow a window of times for transfers
- Could calculate 2-3 additional ejection backwards and forwards in time
- Return "bad" transfer burns in the recent past, until we confirm that it's truly too late
- Calculate current absolute time, then use a fudge factor that scales with orbital period to choose a range, and translate outer ranges into sets of inner ranges
- i18n / l10n
- Clean up hacks
- Split CalculateEjectionBurn into transfer versus ejection functions
- Retrograde orbit special cases
- Split ViewTools: Truly generic stuff versus this project's stuff
- Split MathTools off from PhysicsTools
- Factor out a SimpleMod base class
- App launcher button
- Tooltip
- Main window
- Settings
- Resources
- Event handlers
See [TODO.md](TODO.md).

## Building

### Linux

```sh
git clone [email protected]:HebaruSan/Astrogator.git
cd Astrogator
ln -s /path/to/KSP/KSP_x64_Data src
make
```
See [INSTALL.md](INSTALL.md).

## References

Expand Down
29 changes: 29 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# TODO

- [ ] Reduce ejection burn by the amount the plane change burn adds to it (i.e., fix Minmus overshoots)
- [ ] Allow a window of times for transfers
- Calculate current absolute time
- Use a fudge factor that scales with orbital period to choose a range
- Translate outer ranges into sets of inner ranges
- At the "leaf nodes", choose the center of a range as the burn time
- [ ] i18n / l10n

## More transfer types

- [ ] Capture burns for inbound hyperbolic orbits
- [ ] Launch to orbit
- [ ] Return-to-LKO from Mun and Minmus

## Code style

- [ ] Split CalculateEjectionBurn into transfer versus ejection functions
- [ ] Generalize retrograde orbit special cases
- [ ] Split ViewTools: Truly generic stuff versus this project's stuff
- [ ] Split MathTools off from PhysicsTools
- [ ] Factor out a SimpleMod base class
- App launcher button
- Tooltip
- Main window
- Settings
- Resources
- Event handlers
4 changes: 2 additions & 2 deletions src/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
[assembly: AssemblyVersion("0.2.0.0")]
[assembly: AssemblyFileVersion("0.2.0.0")]
[assembly: AssemblyVersion("0.3.0.0")]
[assembly: AssemblyFileVersion("0.3.0.0")]

0 comments on commit ccc41cc

Please sign in to comment.