From 32176f06b8c8b0f456a479177293f42df221ce39 Mon Sep 17 00:00:00 2001 From: Bruno Dias Date: Mon, 13 Apr 2015 03:19:08 -0300 Subject: [PATCH] Update README --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4289c5b..f152ab4 100644 --- a/README.md +++ b/README.md @@ -34,22 +34,18 @@ Raconteur is still in active development towards its 1.0 release. snippets. - Based on CommonJS principles (Using undum-commonjs), allowing all game code to be bundled using Browserify. +- An advanced game [template](http://github.com/sequitur/raconteur-scaffold/) that sets up a complete development environment for authors: A build system (gulp), CSS preprocessing (Less), and dependency management (Browserify + npm). -## Planned Features +## Planned features -- An advanced game template that sets up a complete development environment - for authors: A build system (gulp), CSS preprocessing (Less), and dependency - management (Browserify + npm). - A complete code refactoring of Undum and Raconteur itself with testability in mind, allowing the use of testing frameworks with Undum stories. ## Installation -For now, clone this git repository. Then, from the root: +Raconteur can be added as a dependency to a package.json file and installed from git. Or, you can use the [scaffold](http://github.com/sequitur/raconteur-scaffold). - npm install - -You will find an useful Gulpfile.js in devel/, among other tools. Eventually, Raconteur will be distributed as a ready-to-use template so that you'll be able to download, install dependencies with `npm install`, and get hacking. +Raconteur itself doesn't contain any command-line tools or anything that needs to be installed globally. You just need `npm` and `gulp` to be working on your system. ## Code examples