Skip to content

Commit

Permalink
Initial commit with a (very) basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sinisterchipmunk committed Mar 4, 2011
0 parents commit 028c4c1
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
*.gem
.bundle
Gemfile.lock
pkg/*
4 changes: 4 additions & 0 deletions Gemfile
@@ -0,0 +1,4 @@
source "http://rubygems.org"

# Specify your gem's dependencies in jax.gemspec
gemspec
49 changes: 49 additions & 0 deletions README.rdoc
@@ -0,0 +1,49 @@
== Important

JAX is a working title and is subject to change.

== JAX

JAX is a framework for developing rich WebGL-enabled applications using JavaScript and Ruby.

== Requirements

It requires ruby, which you can download at: http://www.ruby-lang.org

Other than that, JAX requires a few ruby gems which will be retrieved automatically when installing.

== Installation

First, install ruby. Then, run the following command:

gem install jax

== Getting Started

After installing the gem, you'll need to generate a new JAX project. This is simple:

jax new [project-name]

JAX will generate a whole bunch of files for you.

=== app/

The bulk of your WebGL application will be in the app/
directory. JAX is designed around the MVC (Model-View-Controller) paradigm, and the subdirectories there
should serve to emphasize this fact.

No one file in this location will operate on its own. Instead, the files in app/ will be combined into a
fully-functional app a bit later on.

=== config/

This directory contains the default configuration setup that JAX will use. You can feel free to customize
the files in this directory, but there's no need to do so.

=== public/

This is a location for you to store static files such as images, CSS stylesheets, static HTML pages and supporting
JavaScripts. The public/ directory is treated as a document root, so referencing a file called
<em>/javascripts/hello_world.js</em> will actually retrieve the file
<em>[app_root]/public/javascripts/hello_world.js</em>.

2 changes: 2 additions & 0 deletions Rakefile
@@ -0,0 +1,2 @@
require 'bundler'
Bundler::GemHelper.install_tasks
21 changes: 21 additions & 0 deletions jax.gemspec
@@ -0,0 +1,21 @@
# -*- encoding: utf-8 -*-
$:.push File.expand_path("../lib", __FILE__)
require "jax/version"

Gem::Specification.new do |s|
s.name = "jax"
s.version = Jax::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["TODO: Write your name"]
s.email = ["TODO: Write your email address"]
s.homepage = ""
s.summary = %q{TODO: Write a gem summary}
s.description = %q{TODO: Write a gem description}

s.rubyforge_project = "jax"

s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
end
3 changes: 3 additions & 0 deletions lib/jax.rb
@@ -0,0 +1,3 @@
module Jax
# Your code goes here...
end
3 changes: 3 additions & 0 deletions lib/jax/version.rb
@@ -0,0 +1,3 @@
module Jax
VERSION = "0.0.1"
end
Empty file added spec/jax_generator_spec.rb
Empty file.

0 comments on commit 028c4c1

Please sign in to comment.