Permalink
Browse files

README work [ci skip]

  • Loading branch information...
1 parent 1d4a67d commit bcddf4e04ea66b03ac57549113f8098a11c312a6 @3rd-Eden 3rd-Eden committed Jul 3, 2012
Showing with 56 additions and 16 deletions.
  1. +56 −16 README.md
View
@@ -8,7 +8,7 @@ o-o o-O o--o o o-o o-o
# Square
-The whole purpose of square is to provide you with building blocks to create an
+The purpose of square is to provide you with building blocks to create an
advanced and maintainable build system so you can streamline your development
process and be more productive on a daily basis.
@@ -30,10 +30,26 @@ process and be more productive on a daily basis.
## Installation
-Square requires you to have a minimum version of Node 0.6.10 installed on your
-system. And it might require sudo privileges for installation as it needs to
-install the `square` binary in the `/user/bin` directory. As square comes with a
-command line interface you should use the `-g` dash during NPM installation:
+The square build system is build upon Node.js and it requires a minimum version
+of 0.8. If Node.js is not yet installed on you system you can follow the
+[installation guide](https://github.com/joyent/node/wiki/Installation) or do:
+
+```
+git clone git://github.com/joyent/node.git
+cd node
+git checkout v0.8.0 # check nodejs.org for the latest stable version
+./configure
+make
+make install
+```
+
+In addition to having Node 0.8 installed on your system it might also require
+sudo privileges for installing the `square` binary in your `/usr/bin` directory.
+I assume that you also have NPM (Node Package Manager) installed together with
+your Node.js installation. If not, [install it](http://npmjs.org/) as well. It
+is bundled in the recent node.js version.
+
+Now that we have all our dependencies installed we can start installing square:
```bash
npm install square -g
@@ -46,10 +62,25 @@ add `sudo` in front of the NPM installation command:
sudo npm install square -g
```
-If you want to minify your code you should also have the `java` binary
+If you want to minify your code you should also have the
+[java](http://lmgtfy.com/?q=installing+java) binary
installed on your machine as both YUI and Google Closure compiler are build
on top of it.
+## Documentation
+### Command line flags
+
+1. [watch, --watch](/observing/square/blob/master/doc/flags/watch.md)
+2. [filename, --filename](/observing/square/blob/master/doc/flags/filename.md)
+3. [bundle, --bundle](/observing/square/blob/master/doc/flags/bundle.md)
+4. [extension, --extension](/observing/square/blob/master/doc/flags/extension.md)
+
+### Main pages
+
+1. [The square.json build file](/observing/square/blob/master/doc/square.json.md)
+2. [Transparent pre-processing](/observing/square/blob/master/doc/pre-processors.md)
+2. [Comment directives](/observing/square/blob/master/doc/directive.md)
+
### Development
If you are interested in developing or contributing code to square you can clone
@@ -67,16 +98,25 @@ sudo make install
This ensures that the square binary is symlink so every change you make to the
source code is directly reflected in the binary.
-## Documentation
-### Command line flags
+<a name="license" />
+### License (MIT)
-1. [watch, --watch](/observing/square/blob/master/doc/flags/watch.md)
-2. [filename, --filename](/observing/square/blob/master/doc/flags/filename.md)
-3. [bundle, --bundle](/observing/square/blob/master/doc/flags/bundle.md)
-4. [extension, --extension](/observing/square/blob/master/doc/flags/extension.md)
+Copyright (c) 2012 Observe.it (http://observe.it) <opensource@observe.it>
-### Main pages
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
-1. [The square.json build file](/observing/square/blob/master/doc/square.json.md)
-2. [Transparent pre-processing](/observing/square/blob/master/doc/pre-processors.md)
-2. [Comment directives](/observing/square/blob/master/doc/directive.md)
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

0 comments on commit bcddf4e

Please sign in to comment.