Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dpmcmlxxvi committed Jun 11, 2019
1 parent cc48e62 commit fe02cb7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 21 deletions.
26 changes: 6 additions & 20 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,28 +125,14 @@ <h2>DOCUMENTATION</h2>
<li><a href="http://dpmcmlxxvi.github.io/olexp/api/">API</a></li>
</ul>
<h2>BUILD</h2>
<p>The only requirement for building olexp is <a href="https://nodejs.org">node.js</a>. The
following instructions assume that <code>grunt-cli</code> has been installed globally:</p>
<pre><code>npm install -g grunt-cli
</code></pre>
<p>To build the library clone it, install it, then grunt it</p>
<pre><code>git clone https://github.com/dpmcmlxxvi/olexp.git
npm install
grunt
</code></pre>
<h2>TEST</h2>
<p>To run the unit tests</p>
<pre><code>grunt test
</code></pre>
<p>Then open the coverage report in the <code>coverage</code> directory in a browser.</p>
<h2>NPM</h2>
<p>The olexp library source and distribution is also available as a npm package
<a href="https://www.npmjs.com/package/olexp">here</a>. The following installs the olexp
package:</p>
<pre><code>npm install olexp
<p>To build and test the library locally:</p>
<pre class="prettyprint source lang-shell"><code>npm install
npm test
</code></pre>
<p>Then bundled library and stylesheet are at <code>dist/olexp.min.js</code> and
<code>dist/olexp.min.css</code>.</p>
<h2>LICENSE</h2>
<p>Copyright (c) 2015 Daniel Pulido <a href="mailto:dpmcmlxxvi@gmail.com">dpmcmlxxvi@gmail.com</a></p>
<p>Copyright (c) 2015 Daniel Pulido <a href="mailto:dpmcmlxxvi@gmail.com">mailto:dpmcmlxxvi@gmail.com</a></p>
<p>Source code is released under the <a href="http://opensource.org/licenses/MIT">MIT License</a>.
Documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY 4.0</a>.
Icons are from <a href="http://trac.osgeo.org/osgeo/wiki">OSGeo</a> and released under the
Expand Down
Loading

0 comments on commit fe02cb7

Please sign in to comment.