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

Update user documentation #4

Open
3 tasks
niketagrawal opened this issue Feb 16, 2022 · 0 comments
Open
3 tasks

Update user documentation #4

niketagrawal opened this issue Feb 16, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@niketagrawal
Copy link
Collaborator

niketagrawal commented Feb 16, 2022 •
edited
Loading

  • Provide information on how to run the examples. Mention the pre-requisities, for example, if a licensed software is required.
  • Specify the installation pre-requisites before the installation instructions to have a logical continuity.
  • Provide installation instructions for different Operating systems if applicable.

For example,

Getting started

Pre-requisites

  • Python 3.x

  • Poetry: Install Poetry using ...

  • Linux (if software is Linux only)

Installation

  1. Install the software package using the command ...

Include any command to test the installation of the software if possible. Screenshots showing the output of each command would also be helpful.

Tutorials

Run experiments ...
@niketagrawal niketagrawal added the documentation Improvements or additions to documentation label Feb 16, 2022
maxspahn added a commit that referenced this issue Mar 2, 2022
@maxspahn
Adds explicit short getting started to docs, addresses #4.
36c9a6b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@niketagrawal