Memristor-Robotics/mep-master

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Build Status](https://semaphoreci.com/api/v1/lukicdarkoo/mep-master/branches/master/shields_badge.svg)](https://semaphoreci.com/lukicdarkoo/mep-master)
[![Documentation](https://doc.esdoc.org/github.com/Memristor-Robotics/mep-master/badge.svg)](https://doc.esdoc.org/github.com/Memristor-Robotics/mep-master/)
[![Slack](http://strk.kbt.io/tmp/matrix_badge.svg)](https://memristor-robotics.slack.com/messages)
[![Maintainability](https://api.codeclimate.com/v1/badges/23de86cb5cd79b8a5d3d/maintainability)](https://codeclimate.com/github/Memristor-Robotics/mep-master/maintainability)
[![Dependencies](https://david-dm.org/Memristor-Robotics/mep-master.svg)](https://david-dm.org/Memristor-Robotics/mep-master/)

# mep-master
**mep-master** is a brain of Memristor's Eurobot development platform. This project provicdes a simple API to interact with robot's actuators and sensors, as well as sensor fusion, communication, task scheduling and path finding.
## Installation
*only for Debian & Arch distros

```
curl https://raw.githubusercontent.com/Memristor-Robotics/mep-master/master/install | sh
```

## Execute
```
./mep
```

check for arguments
```
./mep --help
```

## Other commands
- generate local documentation `npm run docs`,
- run tests `npm test`,
- example of custom command `npm run small` (check `package.json > scripts > small`)  

## Long of it
Please use following links for more detailed documentation: 
- [Introduction](docs/Introduction.md)
- [References](https://doc.esdoc.org/github.com/Memristor-Robotics/mep-master/identifiers.html)

## Quick Links
[Simulator](https://github.com/Memristor-Robotics/mep-dash) | 
[Slack](https://memristor-robotics.slack.com/) |
[Trello](https://trello.com/b/96UlYfvl/memristor) |
[Website](https://memristor-robotics.github.io/)