Skip to content

Commit

Permalink
Cleaned up front page with new info
Browse files Browse the repository at this point in the history
  • Loading branch information
Sparen committed Feb 7, 2019
1 parent 67bdd8b commit b71870a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@
<div id="top">
<div class="sm-navbar-container" id="navbar"></div>
<h1 style="background-color:#AAAAAA;color:white">SVG Strip Map Generator</h1>
<div>Welcome to the website for this project - a SVG and JSON-based Strip Map Generator. This project aims to provide a way to generate strip maps from a JSON file, with no need for a vector graphics editor such as Adobe Illustrator or Inkscape (though those tools are, of course, much more powerful). The main advantage of this tool is the ability to change a few parameters in a JSON file and have live updates on a website.</div>
<div>Welcome to the website for this project - a SVG and JSON-based Strip Map Generator. This project aims to provide a way to generate strip maps from JSON stored in a standard JavaScript file, with no need for a vector graphics editor such as Adobe Illustrator or Inkscape (though those tools are, of course, much more powerful). The main advantage of this tool is the ability to change a few parameters in the JSON and have live updates on a website.</div>
<div>Please note that Strip Maps generated by this tool are inevitably going to be extremely simple without knowledge of the Scalable Vector Graphics format. This tool is a work in progress.</div>
<br>

<div>The project repository can be found on <a href="https://github.com/Sparen/StripMapGen">GitHub</a>. You can find the source code for example projects here.</div>
<div>Example Strip Maps generated using this tool:<br>
<a href="./test-network/test-network.html">Test Network</a><br>
<a href="./test-helsinki/test-helsinki.html">Helsinki Metro</a>
<a href="./test-helsinki/test-helsinki.html">Helsinki Metro</a> <br>
<a href="./test-internal/test-internal">Internal Tests</a> (advanced features)
</div>
<div>For documentation on the features, refer to the navbar. In addition, a user guide is under construction.</div>
<div>For documentation on the features, refer to the <a href="./user-guide/index.html">User Guides</a> and <a href="docs.html">Documentation</a>, located on the navbar.</div>
<br>

<div>If you are using this tool in a serious setting (e.g. the maps generated by this tool are *actually* being used in production), <strong>please let me know</strong>. Since this tool is still in its early stages, things are breaking and the specification is changing every few days or so. If you *do* want to use this tool in a production setting at the moment, I highly advise exporting the generated SVG itself rather than hooking into the library to generate the map on the fly from your JavaScript. In the future, there may be proper releases that users can hook into, but for now no such releases exist.</div>
<div>Note that while this project aims to generate all kinds of strip maps, full support for Top-Down languages such as Chinese and Japanese is unlikely to occur as it would overcomplicate the existing specification.</div>
<div>This tool is currently not meant for a production environment and it is highly recommended that if using the Strip Map Generator as a JavaScript library, you obtain a formal release on GitHub. While the specification is still subject to change, attempts will be made to provide backwards compatibility.</div>
</div>
<div>Have a feature request or experiencing bugs? Please open an Issue on GitHub. Thank you!</div>
</div>
Expand Down

0 comments on commit b71870a

Please sign in to comment.