Skip to content
This repository has been archived by the owner on Apr 15, 2020. It is now read-only.

Commit

Permalink
Documentation for 'he create' command.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoglan committed Sep 17, 2009
1 parent 724a6dc commit 4251768
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.rdoc
Expand Up @@ -66,9 +66,9 @@ To install from GitHub:
rake install_gem

With the gem installed, you can install a copy of the web app anywhere on your system
using the +he+ command with the name of the directory to create:
using the +he install+ command with the name of the directory to create:

he helium-app
he install helium-app

This will give you the following files:

Expand Down Expand Up @@ -117,10 +117,12 @@ in its metadata. For example, here's a <tt>jake.yml</tt> file for the +Panel+ pa
source_directory: .
build_directory: .
layout: together

builds:
min:
shrink_vars: true
private: true

packages:
panel:
files:
Expand All @@ -145,6 +147,20 @@ Note that objects listed under +provides+ and +requires+ should be the runtime r
names of JavaScript objects, and anything in the +requires+ list should be provided by
some other package known to the deploy system.

If you're starting a new project, Helium comes with a command line tool that generates
some stub code, a <tt>jake.yml</tt> file and a test page. Just run the following to
create a new project, replacing <tt>project-name</tt> with the name of your library.

he create project-name

After generating a project, you will need to edit its dependencies in <tt>jake.yml</tt>
and edit <tt>test/index.html</tt> to reference your Helium server so that dependencies
can be loaded.

Running +jake+ from the new project directory will build the library for you and generate
a JS.Packages manifest for it. The test page uses <tt>require()</tt> to load your library,
so you'll know if any of its dependency data is missing.

=== The deployment process

Our deployment system performs the following steps on every project registered:
Expand Down
2 changes: 2 additions & 0 deletions bin/he
@@ -1,3 +1,5 @@
#! /usr/bin/env ruby

home = File.join(File.dirname(__FILE__), '..')

require 'fileutils'
Expand Down

0 comments on commit 4251768

Please sign in to comment.