From 573b7f54e990123e9110a934acc8bc4d372ee9e5 Mon Sep 17 00:00:00 2001 From: Frederic Guilbault <37122999+FredericGuilbault@users.noreply.github.com> Date: Sun, 29 Mar 2020 13:23:06 -0400 Subject: [PATCH] prettyfy the README file --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4057043..044bbed 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ -This repository contains data files used by pypilot user interfaces. +# pypilot_data -To avoid excessive clone times (or timeouts) they are kept in a separate repository. +##### This repository contains some of the static assets used by the differents pypilot user interfaces. +> *The static assets are kept in a separate repository to prevent excessive clone times (or timeouts)* -Simply extract them into the locations needed, eg: +## Install + +Simply clone the repository and move files in the root of pypilot repository. + +If you don't have pypilot repository already. start by cloning it: +```sh git clone https://github.com/pypilot +``` +Then simply clone the repository and move files in pypilot repository. +```sh git clone https://github.com/pypilot_data cp -rv pypilot_data/* pypilot +``` +And it's done, Your next step will probably be to build and install pypilot, For this please refer to the [pypilot README file](https://github.com/pypilot/pypilot/blob/master/README) for install procedure.