Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronblohowiak committed Oct 1, 2011
1 parent bab77b6 commit 3585538
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
1 change: 0 additions & 1 deletion README

This file was deleted.

35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Setup

To setup, just clone this repo, and `npm install`.

To start the less compilation in the background, use:

make lessc

This will use `restartr` to monitor files for changes and recompile public/app.css

To start the server, use:

make server

This will use `restartr` to monitor files for changes and will restart the server. Sometimes, restartr sucks and doesn't actually kill the child process (there is a race condition I haven't sorted out) so you have to ctrl+c this and restart it manually -- but when you do so, the child process will be reaped appropriately and everything will "just work".

Alternately, you can use:

node server.js

but then you *have to* restart the server manually because the staticprovider will cache the file contents in memory. it is on my TODO to change this.

# Layout

You probably want to edit stuff in `templates/`, `controllers/` and `less/dxdt.less`.

The marketing layout is:

`templates/marketing.haml`


## Note to self:

Note: give credit for:
Magnifying glass icons: http://shapeshed.com/journal/free_icon_set_quant/

0 comments on commit 3585538

Please sign in to comment.