Skip to content
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

Getting started README #13

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

McDonaldsHappyMeal
Copy link

Created a getting_started.md file, that goes into a little bit of detail on topics PacSim subscribes to, what they mean, and regurgitates some other information already present in the main README and the ARWO presentation slides.

If there's anything you'd like me to change, please let me know :>

|------------------------------|----------------------------|---------------------------------------------------------------------------------------|---|
| /pacsim/steering_setpoint | pacsim::msg::StampedScalar | Target steering angle at the steering wheel/sensor (rad) | YES |
| /pacsim/torques_max | pacsim::msg::Wheels | Upper bound torque value at each wheel's motor (Nm) | YES |
| /pacsim/powerground_setpoint | pacsim::msg::StampedScalar | Powered ground multiplier. 0 for no powered aero, 1 for full capacity (Dimensionless) | YES |
Copy link
Contributor

Choose a reason for hiding this comment

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

Please put this in the last row so that related topics are grouped together

Copy link
Author

Choose a reason for hiding this comment

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

Sorry, I don't fully understand the order in which you want me to put these topics, but I will recommit with a newly sorted one and see if you like it. If you don't like it, let me know.

doc/getting_started.md Outdated Show resolved Hide resolved
doc/getting_started.md Outdated Show resolved Hide resolved
doc/getting_started.md Outdated Show resolved Hide resolved
doc/getting_started.md Outdated Show resolved Hide resolved
doc/getting_started.md Outdated Show resolved Hide resolved
@alexphieler
Copy link
Contributor

I think it makes sense to have a section for the simulator inputs and outputs each. Could you add that structure to the README and just put a "TBD" placeholder for the outputs?

  • Getting started
    • Interfaces
      • Inputs
      • Outputs
    • Other notes

@alexphieler
Copy link
Contributor

Also in the table, could you replace "USED" with "USED WITH DEFAULT MODEL"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants