Skip to content

Update markdown of headings in README.md #110

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
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Update markdown of headings in README.md #110

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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Bulldog currently supports the following features:
- All UARTs (including dynamic setup via capemgr on request)
- A few devices: Simple button API, Incremental Rotary Encoder, Servos, LCD, ...

##Usage
## Usage

###Maven
### Maven

Stable versions are synced with Maven Central. You just need to add a dependency to appropriate board implementation and Bulldog will automatically select the correct platform implementation:

Expand Down Expand Up @@ -57,7 +57,7 @@ To use our development (SNAPSHOT) versions you need to add the following reposit
</repositories>
```

###Example
### Example

The following steps can all be performed on your target device (e.g. RaspberryPi).

Expand Down Expand Up @@ -129,9 +129,9 @@ mvn exec:java

_Note: For more see [bulldog-examples](https://github.com/px3/bulldog-examples) project._

##Building Bulldog (x86, x86_64)
## Building Bulldog (x86, x86_64)

###Prerequisites
### Prerequisites

- ARM C/C++ Cross Compiler (4.8+)
- Maven 3+
Expand All @@ -145,7 +145,7 @@ Ubuntu (13.04+)

sudo apt-get install gcc-4.8-arm-linux-gnueabihf

###Build
### Build

Fedora (default)

Expand All @@ -155,9 +155,9 @@ Ubuntu - need to overide compiler/linker binary:

mvn clean install -Dcompiler.exec=arm-linux-gnueabihf-gcc-4.8 -Dlinker.exec=arm-linux-gnueabihf-ld

##Building Bulldog (ARM)
## Building Bulldog (ARM)

###Prerequisites
### Prerequisites

- ARM C/C++ Compiler (4.8+)
- Maven 3+
Expand All @@ -166,15 +166,15 @@ Raspbian

sudo apt-get install gcc-4.8

###Build
### Build

mvn clean install -Pnative-compile

##Continuous Integration
## Continuous Integration

CI server hosted on Travis-ci.org: [![Build Status](https://travis-ci.org/px3/bulldog.svg?branch=master)](https://travis-ci.org/px3/bulldog)

##Contribution Guidelines
## Contribution Guidelines

- If you find a bug, or have a feature request you think we should consider, please report it [here](https://github.com/px3/bulldog/issues).
- We use [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) as a development workflow, so If you want to contribute to our code base create your own fork & send a pull request to the devel branch or ask to join our community to be able to commit directly to devel branch.