Update user documentation - Githubissues

tud-amr / localPlannerBench

Local Planner Bench

https://tud-amr.github.io/localPlannerBench/

GNU General Public License v3.0

50 stars 5 forks source link

Update user documentation #4

Open niketagrawal opened 2 years ago

niketagrawal commented 2 years ago

[ ] 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

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 ...