From 259d282c8acbb813c2e8e567149aaa36b4e9da10 Mon Sep 17 00:00:00 2001 From: treyfortmuller Date: Tue, 31 Dec 2019 00:37:27 -0800 Subject: [PATCH] added instructions on startup and some for drone 3d sim --- .gitignore | 2 ++ .../drone_3d_trajectory_following/README.md | 7 +++++ README.md | 26 ++++++++++++------- 3 files changed, 25 insertions(+), 10 deletions(-) create mode 100644 AerialNavigation/drone_3d_trajectory_following/README.md diff --git a/.gitignore b/.gitignore index 272dc63b6d..62d70715a7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +venv/ + *.csv *.gif *.g2o diff --git a/AerialNavigation/drone_3d_trajectory_following/README.md b/AerialNavigation/drone_3d_trajectory_following/README.md new file mode 100644 index 0000000000..ca12c502d1 --- /dev/null +++ b/AerialNavigation/drone_3d_trajectory_following/README.md @@ -0,0 +1,7 @@ +Make sure you have `python3-tk` installed for this example + +``` +sudo apt install python3-tk +``` + +then `python3 drone_3d_trajectory_following.py` will launch the simulator and open a GUI with the animation. diff --git a/README.md b/README.md index f48e9c0ef3..384fb8cec7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ -header pic # PythonRobotics -[![Build Status](https://travis-ci.org/AtsushiSakai/PythonRobotics.svg?branch=master)](https://travis-ci.org/AtsushiSakai/PythonRobotics) -[![Documentation Status](https://readthedocs.org/projects/pythonrobotics/badge/?version=latest)](https://pythonrobotics.readthedocs.io/en/latest/?badge=latest) -[![Build status](https://ci.appveyor.com/api/projects/status/sb279kxuv1be391g?svg=true)](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics) -[![Coverage Status](https://coveralls.io/repos/github/AtsushiSakai/PythonRobotics/badge.svg?branch=master)](https://coveralls.io/github/AtsushiSakai/PythonRobotics?branch=master) -[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/AtsushiSakai/PythonRobotics.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/AtsushiSakai/PythonRobotics/context:python) -[![CodeFactor](https://www.codefactor.io/repository/github/atsushisakai/pythonrobotics/badge/master)](https://www.codefactor.io/repository/github/atsushisakai/pythonrobotics/overview/master) -[![tokei](https://tokei.rs/b1/github/AtsushiSakai/PythonRobotics)](https://github.com/AtsushiSakai/PythonRobotics) -[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/AtsushiSakai) -Python codes for robotics algorithm. +To run examples: +* Create a python3 venv +``` +python3 -m venv venv +``` +* Activate the venv +``` +source ./venv/bin/activate +``` + +* Install the requirements with pip +``` +pip install -r requirements.txt +``` + +* Run an example. # Table of Contents * [What is this?](#what-is-this)