Skip to content

Commit

Permalink
update with friendlier instructions
Browse files Browse the repository at this point in the history
[#98004938]
  • Loading branch information
mhoran committed Jun 29, 2015
1 parent 627d2de commit 92df995
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 4 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

## Run the tests

```bash
bundle
bundle exec rspec
```

## Pull Requests

1. Fork the project
1. Submit a pull request
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
## Binary Builder
# Introduction

This tool provides a mechanism for building binaries.
This tool provides a mechanism for building binaries for the Cloud Foundry buildpacks.

### Running within Docker
## Currently supported binaries

When building binaries for CloudFoundry, it may be useful to run `binary-builder` from within a CF rootfs. The cflinuxfs2 rootfs may be used as follows:
* NodeJS
* Ruby
* JRuby
* Python
* PHP
* nginx
* Apache HTTD Server

# Usage

The scripts are meant to be run on a Cloud Foundry [stack](https://docs.cloudfoundry.org/concepts/stacks.html).

## Running within Docker

To run `binary-builder` from within the cflinuxfs2 rootfs, use [Docker](https://docker.io):

```bash
docker run -w /binary-builder -v `pwd`:/binary-builder -it cloudfoundry/cflinuxfs2 bash
./bin/binary-builder [binary_name] [binary_version]
```

This generates a gzipped tarball in the binary-builder directory with the filename format `binary_name-binary_version-linux-x64`.

For example, if you were building nginx 1.7.11, you'd run the following commands:

```bash
$ docker run -w /binary-builder -v `pwd`:/binary-builder -it cloudfoundry/cflinuxfs2 ./bin/binary-builder nginx 1.7.11
$ ls
nginx-1.7.11-linux-x64.tar.gz
```

# Contributing

Find our guidelines [here](./CONTRIBUTING.md).

# Reporting Issues

Open an issue on this project

# Active Development

The project backlog is on [Pivotal Tracker](https://www.pivotaltracker.com/projects/1042066)

0 comments on commit 92df995

Please sign in to comment.