Skip to content

Commit

Permalink
#443 Add document snap and badge to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ataffanel committed Sep 14, 2020
1 parent 0c1de27 commit dfebae9
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Crazyflie PC client [![Build Status](https://api.travis-ci.org/bitcraze/crazyflie-clients-python.svg)](https://travis-ci.org/bitcraze/crazyflie-clients-python) [![Build status](https://ci.appveyor.com/api/projects/status/u2kejdbc9wrexo31?svg=true)](https://ci.appveyor.com/project/bitcraze/crazyflie-clients-python)
# Crazyflie PC client [![Build Status](https://api.travis-ci.org/bitcraze/crazyflie-clients-python.svg)](https://travis-ci.org/bitcraze/crazyflie-clients-python) [![Build status](https://ci.appveyor.com/api/projects/status/u2kejdbc9wrexo31?svg=true)](https://ci.appveyor.com/project/bitcraze/crazyflie-clients-python) [![cfclient](https://snapcraft.io//cfclient/badge.svg)](https://snapcraft.io/cfclient)


The Crazyflie PC client enables flashing and controlling the Crazyflie.
Expand All @@ -7,6 +7,39 @@ The communication with Crazyflie and the implementation of the CRTP protocol to

For more info see our [documentation](https://www.bitcraze.io/documentation/repository/crazyflie-clients-python/master/).

# Installing from build

## Linux

The client can be installed and run with snap, it can be found on [snapcraft](https://snapcraft.io/cfclient) (ie. search Crazyflie in Ubuntu software) or installed from command line:
```
snap install --edge cfclient
snap connect cfclient:raw-usb # Required to access the Crazyradio
snap connect cfclient:joystick # Required to access gamepads
```

The only build available right now is the latest commit from github (edge), the next version will be pushed in the snapcraft stable channel.

It is still required to set the udev permission with the snap, see the last section of this page.

## Windows

A windows installer is automatically built for each git commit in [appveyor](https://ci.appveyor.com/project/bitcraze/crazyflie-clients-python/build/artifacts).

For each release, the release built is available in the [github release page](https://github.com/bitcraze/crazyflie-clients-python/releases).

To use Crazyradio you will have to [install the drivers](https://github.com/bitcraze/crazyradio-firmware/blob/master/docs/building/usbwindows.md).

## From Pypi (Windows, Mac, Linux, ..., with python3)

Each release of the client is pushed to the [pypi repository](https://pypi.org/project/cfclient/). If you have python >= 3.5, it can be installed with pip:

```
python3 -m pip install cfclient pyqt5
```

Mac and windows will also need the SDL2 library to be installed (see bellow)

# Running from source

The Crazyflie client requires [cflib](https://github.com/bitcraze/crazyflie-lib-python).
Expand Down

0 comments on commit dfebae9

Please sign in to comment.