Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Latest commit

 

History

History
57 lines (35 loc) · 2.72 KB

README.md

File metadata and controls

57 lines (35 loc) · 2.72 KB
Raw

Treesaver

Treesaver is JavaScript framework for creating magazine-style layouts using standards-compliant HTML and CSS.

Getting Started / Documentation

The Treesaver wiki is the best source of documentation and reference. Note that the documentation is still a work in progress.

Support/Questions

Use the Treesaver.js Mailing List.

Building Treesaver

Use the instructions below if you wish to build Treesaver from scratch. Most people are better off downloading a pre-built version.

Dependencies

Setup Instructions

  1. Make sure to install all the dependencies
  2. Clone a copy of the Treesaver repo by running: git clone git://github.com/treesaver/treesaver.git

Commands

Note that these commands must be run from the root directory of the repository. You can type cake to view available commands.

  • cake deps: Create dependency script for testing
  • cake compile: Compile JavaScript files for production. Can be used with one or more compilation flags:
    • cake --debug compile: Use debug-friendly minification
    • cake --ios compile: Compile version for use within an IOS UIWebView
  • cake debug: Concatenate files for use when debugging (preserves comments, formatting, etc). Supports the following compilation flags:
    • cake --ios debug: Compile version for use within an IOS UIWebView
  • cake lint: Check style with lint
  • cake fix_lint: Automatically fix lint errors
  • cake clean: remove build artifacts

License

Dual-licensed under MIT and GPLv2

Contributing

Coding Style

Yes, the code looks verbose and kind of like Java. That is because it follows the Google Closure style. This is in order to get better compression via the Closure Compiler. UglifyJS shows a lot of potential, and merits investigation.

Although Google Closure style and compiler are used, note that Treesaver does not use the Closure Library (other than a few functions in base.js which are used for dependency management and are not present in production).

Contributors