Skip to content

DOC: update README.md with new features of v1.0.0a1. #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 1, 2023

Conversation

phmbressan
Copy link
Collaborator

Pull request type

Please check the type of change your PR introduces:

  • Code base additions (bugfix, features)
  • Code maintenance (refactoring, formatting, renaming, tests)
  • ReadMe, Docs and GitHub maintenance
  • Other (please describe):

Pull request checklist

Please check if your PR fulfills the following requirements, depending on the type of PR:

  • ReadMe, Docs and GitHub maintenance:

    • Spelling has been verified
    • Code docs are working correctly

What is the current behavior?

Documentation was out of date regarding features of v1.0.0a1.

What is the new behavior?

Readme.md was updated with essential info regarding HybridMotor and LiquidMotor.

Does this introduce a breaking change?

  • Yes
  • No

@phmbressan phmbressan added the Docs Docs and examples related label Jul 1, 2023
@phmbressan phmbressan added this to the Release v1.0.0 milestone Jul 1, 2023
@phmbressan phmbressan requested a review from giovaniceotto as a code owner July 1, 2023 14:35
@phmbressan phmbressan self-assigned this Jul 1, 2023
If you want to see the trajectory on Google Earth, RocketPy acn easily export a KML file for you:

```python
test_flight.export_kml(file_name="test_flight.kml")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will give a candy to whoever adds a good picture of trajectory plotted on Google Earth

extra candy if it is a GIF

Copy link
Member

@Gui-FernandesBR Gui-FernandesBR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done, @phmbressan !!

I updated a few things in the file. Please check it and merge whenever you want.
Could you please confirm that the simulation steps (given in the README) work on your machine?

Ty again!

@Gui-FernandesBR Gui-FernandesBR mentioned this pull request Jul 1, 2023
7 tasks
@phmbressan
Copy link
Collaborator Author

The README.md simulations are working correctly here, I will merge this PR, but we ought to remember to update the diagrams in v1.0.0.

@phmbressan phmbressan merged commit c888507 into beta/v1.0.0 Jul 1, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the doc/update-readme branch July 4, 2023 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants