Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.01 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.01 KB

Isfahan

Isfahan is a javascript library, based on d3.js, for creating tiling window environments within webpages.

Who uses Isfahan

Installation

  • Install node.js: see https://nodejs.org/download/
  • Clone the repository: git clone https://github.com/aeschylus/Isfahan.git
  • Install project dependencies: npm install
  • Add gulp to your path, if needed: sudo npm install -g gulp

Developer's Guide

The best way to contribute to Isfahan is by starting with the example project provided by the library. The following assumes you have completed the installation instructions above:

  • Change into the examples directory: cd Isfahan/examples
  • Run ./run.sh (requires Python) which performs the next two steps:
  • Run gulp watch & to rebuild as files are modified (& runs in background)
  • Point a webserver to the examples directory, e.g. SimpleHTTPServer: python -m SimpleHTTPServer
  • Point your browser to: <your-browser> localhost:8000