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.

Sign up for GitHub

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

Jump to bottom

Refactor README #171

Open
bemcdonnell opened this issue Dec 30, 2022 · 0 comments · May be fixed by #235
Open

Refactor README #171

bemcdonnell opened this issue Dec 30, 2022 · 0 comments · May be fixed by #235
Assignees
@aerispaha
Milestone
v1.0

Comments

@bemcdonnell
Copy link
Member

Proposed Sections

  1. Title
  2. Intro/background/What It Does
  3. How to install / links to documentation and tutorial
  4. Simple Interaction "How-to" a) interact with model info, edit/save INP, run, read RPT, read OUT
  5. Simple Plot "How-to" a) map plot, profile plot
  6. References
@bemcdonnell bemcdonnell added this to the v1.0 milestone Dec 30, 2022
@aerispaha aerispaha self-assigned this Dec 17, 2024
@aerispaha aerispaha linked a pull request Dec 18, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aerispaha aerispaha

Labels
None yet
Projects
None yet
Milestone
v1.0
Development

Successfully merging a pull request may close this issue.

Docs enhancements pyswmm/swmmio
2 participants
@bemcdonnell @aerispaha