neutrinoscript
Version:
Like C for Javascript
84 lines (51 loc) • 3.51 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#convertToJS">convertToJS</a></li><li><a href="global.html#run">run</a></li><li><a href="global.html#runBinary">runBinary</a></li><li><a href="global.html#web">web</a></li><li><a href="global.html#webToJS">webToJS</a></li></ul>
</nav>
<div id="main">
<section class="readme">
<article><h1>Neutrino Script</h1><p><img src="https://raw.githubusercontent.com/active9/neutrinoscript/master/neutrino.png" alt="NeutrinoScript">
Like C for Javascript</p>
<h1>About</h1><p>Neutrino script is a subset of javascript designed to allow low level memory management, shortcodes, defines, and more. See our website at http://neutrinoscript.com/ for more detailed documentation.</p>
<p>The syntax is fresh yet similar to javascript while providing extra abstraction layers to allow more logical code production. This means a script written in Neutrino script can be converted into javascript as it is converted into javascript during the complation process.</p>
<h1>Supported Javascript</h1><p>Currently Neutrino script is designed to run under EMCAScript 5 equivalent javascript syntax only.</p>
<h1>Installing</h1><p>Using npm on your command prompt / terminal run the following commands:</p>
<pre class="prettyprint source lang-bash"><code>npm install -g neutrino
npm install -g neutrino-memory</code></pre><h1>Getting Started</h1><p>See our documentation on our website http://neutrinoscript.com/ for examples of how to write neutrinoscript .neu files.</p>
<h1>Converting NeutrinoScript to Javascript</h1><p>neutrino convert /path/to/your/script.neu /output/path/script.js</p>
<h1>Running via NodeJS</h1><p>neutrino /path/to/your/script.neu</p>
<h1>Running in the Browser</h1><p>Please see the documentation on how to use the provided build/neutrino.js file on the web.</p>
<p>** Changes from 1.0.1 to 1.1.0 introduce a new way to load neutrino script via the web.</p>
<p>Simply replace:</p>
<pre class="prettyprint source lang-javascript"><code>window.neutrino.web(document);</code></pre><p>with</p>
<pre class="prettyprint source lang-javascript"><code>var neutrino = require('neutrino');
neutrino.web(document);</code></pre><h1>License</h1><p>Neutrino script is licensed under the MIT license</p></article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Aug 09 2016 23:51:00 GMT-0400 (Eastern Daylight Time) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>