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

Need getting started documentation for users #110

Open
8 tasks
dmdunla opened this issue May 23, 2023 · 0 comments
Open
8 tasks

Need getting started documentation for users #110

dmdunla opened this issue May 23, 2023 · 0 comments
Assignees
@dmdunla
Labels
documentation Improvements or additions to documentation
Milestone
v2.0.0

Comments

@dmdunla
Copy link
Collaborator

dmdunla commented May 23, 2023 •
edited
Loading

The contributing guide has info for developers, but there are no simple instructions in the README for getting started as a user. Elements to include:

  • Link to MATLAB TTB
  • List of algorithms
  • List of data classes
  • How to install
  • Link to RTD docs
  • Link to tutorials
  • How to contribute
  • How to cite
@dmdunla dmdunla added the documentation Improvements or additions to documentation label May 23, 2023
@dmdunla dmdunla added this to the v2.0 milestone May 23, 2023
@dmdunla dmdunla self-assigned this May 23, 2023
This was referenced Sep 27, 2023
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmdunla dmdunla

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
1 participant
@dmdunla