0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

update download / getting started

Browse source
This commit is contained in:
rolux 2012-06-21 18:50:14 +02:00
parent f04f6d2663
commit 211d641662
2 changed files with 21 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
readme/getting_started.html
View file

@ -1,3 +1,22 @@
<h1>Getting Started with OxJS</h1>
<p>Nothing to see here yet, please move along...</p>
<p><pre>&lt;!DOCTYPE HTML&gt;
&lt;html&gt;
&lt;head&gt;
&lt;script type="text/javascript" src="OxJS/build/Ox.js"&gt;&lt;/script&gt;
&lt;script&gt;
Ox.load(function() {
// Your code here.
});
&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;&lt;/body&gt;
&lt;/html&gt;</pre><p>
<p>To include <code>Ox.UI</code>, start with <code>Ox.load('UI', function() { ... })</code>.</p>
<p>For the development version, use <code>OxJS/dev/Ox.js</code> instead.<p>
<p>If you're making changes to <code>OxJS</code> (methods, widgets, modules, etc.), make them in <code>source/</code>, not in <code>dev/</code>. <code>dev/</code> contains symlinks to <code>source/</code> (plus some json files to tell <code>Ox.load</code> which resources to include), so your edits will be live.</p>
<p>To add or remove files, or to rebuild the production version, run <code>/tools/build/build.py</code>. This will update both <code>build/</code> and <code>dev/</code> from <code>source/</code>.</p>

14
readme/index/download.html
View file

@ -17,19 +17,7 @@
<p>Or get <code>Ox.js</code> only: &nbsp;<a href="https://oxjs.org/oxjs/build/Ox.js"><code>Ox.js</code></a>{size.minified}.</p>
<br>
<h2><b>Getting Started</b></h2>
<pre>&lt;!DOCTYPE HTML&gt;
&lt;html&gt;
&lt;head&gt;
&lt;script type="text/javascript" src="OxJS/build/Ox.js"&gt;&lt;/script&gt;
&lt;script&gt;
Ox.load(function() {
// Your code here.
});
&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;&lt;/body&gt;
&lt;/html&gt;</pre>
<p>For the development version, use <code>OxJS/dev/Ox.js</code> instead. And to include <code>Ox.UI</code>, start with <code>Ox.load('UI', function() { ... })</code>.</p>
<p>Take a look at our short <a href="#readme/getting_started">tutorial</a>.</p>
<br>
<h2><b>License</b></h2>
<p>Dual-licensed, <a href="http://en.wikipedia.org/wiki/GNU_General_Public_License">GPL</a>/<a href="http://en.wikipedia.org/wiki/MIT_License">MIT</a>. You can pick either. In a nutshell, the former says no derived work may be more restrictive, while the latter avoids to make that restriction.</p>