Skip to content

Commit

Permalink
first version of Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
felipessalvatore committed Feb 17, 2018
1 parent 6ddba5c commit 2f650b5
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,79 @@
[![Build Status](https://travis-ci.org/felipessalvatore/self_driving_project.svg?branch=master)](https://travis-ci.org/felipessalvatore/self_driving_project)
[![License](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/felipessalvatore/self_driving_project/blob/master/LICENSE)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```


## Built With

* [Tensorflow](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [NXT-python](https://maven.apache.org/) - Dependency Management

### Citation
```
@misc{self_driving_project2018,
author = {Paula Moraes, Felipe Salvatore},
title = {Self Driving Project},
year = {2018},
howpublished = {\url{https://github.com/felipessalvatore/self_driving_project}},
note = {commit xxxxxxx}
}
```

### Related Work
- Project M (https://medium.com/@project_m)




Our project of self driving car

To run the raspberry pi test type:
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
name='self-driving-project',
version='0.1',
description='Autonomous car in rasberry pi with tensorflow',
author='Paula Moraes, Felipe Salvatore',
packages=find_packages(),
test_suite="tests"
)

0 comments on commit 2f650b5

Please sign in to comment.