Skip to content

prettify the README file #3

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

Open
FredericGuilbault wants to merge 1 commit into
base: master
Choose a base branch
from
Open

prettify the README file #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.