Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added README and LICENSE

  • Loading branch information...
commit 16e16b82ebcc4a80e6e8b7540fe95ef1aa6431aa 1 parent 2fc5460
@Munter authored
Showing with 71 additions and 0 deletions.
  1. +8 −0 LICENSE.txt
  2. +63 −0 README.md
View
8 LICENSE.txt
@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Peter Müller <munter@fumle.dk>
+
+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:
+
+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.
View
63 README.md
@@ -0,0 +1,63 @@
+# AssetViz
+
+A command line web application source code visualization tool.
+
+![Example](https://raw.github.com/munter/assetviz/master/example/assetviz.png)
+
+## Installation
+
+```
+npm install assetviz
+```
+
+If you get installation errors for node-canvas, don't despair. It's an optional dependency used by [Assetgraph](https://github.com/One-com/assetgraph) to do some other cool stuff that isn't used in AssetViz.
+
+## Usage
+
+
+```
+$ assetviz [-h] [-v] [-r /path/to/webroot] /path/to/webroot/index.html
+$ google-chrome assetviz.html
+```
+
+The command line tool outputs an html-file called `assetviz.html` in the current working directory.
+
+### Arguments:
+
+- Any number of html.files
+- A path, assetviz will look for `index.html` in that path
+- A minimatch pattern like `path/to/webroot/**/*.html`
+- An URL *(yes, you read that right)*
+
+### Parameters:
+
+**-h** : **Help**
+
+**-v** : **Verbose**. Includes inline assets in the output graph. If unset only inline elements relevant to describe file relations will be shown.
+
+**-r** : **Root**. Tells AssetViz which directory to treat as the web root. Only useful if you are graphing an html-file that has relations outside its own directory.
+
+## AssetViz output
+
+The outputted graph html-file is called `assetviz.html`. It is a self contained file with no external dependencies, so you can upload it anywhere, email it or do whatever you want with it without worrying about dependencies or being online to view.
+
+While viewing the graph you can use the mousewheel to zoom and click+drag to pan (google maps style navigation).
+
+
+## Future roadmap
+
+- Improve text rendering
+- Highlight relations on hover
+- Relation direction with arrow heads
+- Merge visualization template with [grunt-dependencygraph](https://github.com/auchenberg/grunt-dependencygraph)
+
+
+## Thanks to
+
+[Andreas Lind Petersen](https://github.com/papandreou) for all his wonderful work on [Assetgraph](https://github.com/One-com/assetgraph). We have barely scratched the surface of the potential this project has.
+[Kenneth Auchenberg](https://github.com/auchenberg) for his visualization work and revitalization of the source code visualization dream.
+
+
+## License
+
+[MIT](https://raw.github.com/munter/assetviz/master/LICENSE.txt)
Please sign in to comment.
Something went wrong with that request. Please try again.