This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Update README.md

  • Loading branch information...
ddollar committed Jan 5, 2012
1 parent de0e4d3 commit af2e3561388c46c469f2263883a2b0949114e430
Showing with 1 addition and 80 deletions.
  1. +1 −80 README.md
View
@@ -1,80 +1 @@
# Vulcan
A build server in the cloud.
## Usage
$ vulcan help
Tasks:
vulcan build # build a piece of software for the heroku cloud using COMMAND as a build command if no COMMAND is...
vulcan create APP_NAME # create a build server on Heroku
vulcan help [TASK] # Describe available tasks or one specific task
vulcan update # update the build server
$ vulcan help build
Usage:
vulcan build
Options:
-c, [--command=COMMAND] # the command to run for compilation
-n, [--name=NAME] # the name of the library (defaults ot the directory name)
-o, [--output=OUTPUT] # output build artifacts to this file
-p, [--prefix=PREFIX] # the build/install --prefix of the software
-s, [--source=SOURCE] # the source directory to build from
-v, [--verbose] # show the full build output
build a piece of software for the heroku cloud using COMMAND as a build command
if no COMMAND is specified, a sensible default will be chosen for you
## Examples
### Create a Build Server
$ vulcan create vulcan-david
Creating vulcan-david... done, stack is cedar
http://vulcan-david.herokuapp.com/ | git@heroku.com:vulcan-david.git
...
### Build
$ vulcan build -s ~/Code/memcached -p /tmp/memcached -c "./autogen.sh && ./configure --prefix=/tmp/memcached && make install"
>> Packaging local directory
>> Uploading code for build
>> Building with: ./autogen.sh && ./configure --prefix=/tmp/memcached && make install
>> Downloading build artifacts to: /tmp/memcached.tgz
$ tar tvf /tmp/memcached.tgz
drwx------ 0 u24714 24714 0 Sep 21 20:25 bin/
-rwxr-xr-x 0 u24714 24714 273082 Sep 21 20:25 bin/memcached
drwx------ 0 u24714 24714 0 Sep 21 20:25 include/
drwx------ 0 u24714 24714 0 Sep 21 20:25 include/memcached/
-rw-r--r-- 0 u24714 24714 14855 Sep 21 20:25 include/memcached/protocol_binary.h
drwx------ 0 u24714 24714 0 Sep 21 20:25 share/
drwx------ 0 u24714 24714 0 Sep 21 20:25 share/man/
drwx------ 0 u24714 24714 0 Sep 21 20:25 share/man/man1/
-rw-r--r-- 0 u24714 24714 5304 Sep 21 20:25 share/man/man1/memcached.1
### Keep the Build Server Updated
$ vulcan update
Initialized empty Git repository in /private/var/folders/rm/qksq9jk15vx0xcjxkqc8yg5w0000gn/T/d20110921-70016-1iksqwy/.git/
Counting objects: 176, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (156/156), done.
Writing objects: 100% (176/176), 326.86 KiB, done.
Total 176 (delta 5), reused 0 (delta 0)
-----> Heroku receiving push
-----> Node.js app detected
-----> Vendoring node 0.4.7
-----> Installing dependencies with npm 1.0.27
Dependencies installed
-----> Discovering process types
Procfile declares types -> web
-----> Compiled slug size is 5.5MB
-----> Launching... done, v5
http://vulcan-david.herokuapp.com deployed to Heroku
To git@heroku.com:vulcan-david.git
+ 2e69a42...eddcb91 master -> master (forced update)
This repo has been moved to [heroku/vulcan](http://github.com/heroku/vulcan)

2 comments on commit af2e356

@doismellburning

This comment has been minimized.

Show comment
Hide comment
@doismellburning

doismellburning Mar 10, 2012

This commit seems to have been pushed to heroku/vulcan, thereby wiping out what presumably should be the canonical README. I don't know for what repo it was intended, but I presume someone should revert it from here?

doismellburning replied Mar 10, 2012

This commit seems to have been pushed to heroku/vulcan, thereby wiping out what presumably should be the canonical README. I don't know for what repo it was intended, but I presume someone should revert it from here?

@ddollar

This comment has been minimized.

Show comment
Hide comment
@ddollar

ddollar Mar 12, 2012

Contributor

Fixed, thanks

Contributor

ddollar replied Mar 12, 2012

Fixed, thanks

Please sign in to comment.