Skip to content
This repository has been archived by the owner on Jul 3, 2021. It is now read-only.

Commit

Permalink
fixed markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
ubunatic committed Aug 15, 2011
1 parent c483c03 commit 921d0ad
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Expand Up @@ -19,29 +19,29 @@ Project Contents

Hot Coffee Brewer comprises the following parts:

.hotcoffee/tools/hotcoffee.js: # compiles 'compile.co' and 'cotest.co'
.hotcoffee/tools/compile.co: # compiles *.co in ./src to *.js in ./lib
.hotcoffee/tools/cotest.co: # runs tests on compiled JavaScript files
.hotcoffee/tools/hotcoffee.js: # compiles 'compile.co' and 'cotest.co'
.hotcoffee/tools/compile.co: # compiles *.co in ./src to *.js in ./lib
.hotcoffee/tools/cotest.co: # runs tests on compiled JavaScript files

build.js: # sample buildfile calls hotcoffee.js
src/world.co # sample CoffeeScript class 'World'
src/test.co # sample CoffeeScript file to test 'World'
build.js: # sample buildfile calls hotcoffee.js
src/world.co # sample CoffeeScript class 'World'
src/test.co # sample CoffeeScript file to test 'World'


Hot Coffee Usage
----------------

1. Test if the sample files compile and the test runs through:

node build.js
node build.js

2. Create your own build.js, create ./src and ./lib, copy hotcoffee, and run:

mkdir ~/yourproject/src
mkdir ~/yourproject/lib
cp .hotcoffee ~/yourproject
cd ~/yourproject
node build.js
mkdir ~/yourproject/src
mkdir ~/yourproject/lib
cp .hotcoffee ~/yourproject
cd ~/yourproject
node build.js

This will compile all .co files in your ./src dir to .js files in ./lib
and run all test files as specified in your build.js.
Expand All @@ -50,9 +50,9 @@ Hot Coffee Issues
-----------------
Many things are hard coded. You may want to change some of the files.

Issue 1: compiles only .co files (no .coffee files)
Issue 2: filters error output and reformats is to better serve Gedit (Linux)
Issue 3: no error grepping for other editors/IDEs
* Issue 1: compiles only .co files (no .coffee files)
* Issue 2: filters error output and reformats is to better serve Gedit (Linux)
* Issue 3: no error grepping for other editors/IDEs



0 comments on commit 921d0ad

Please sign in to comment.