added readme

This commit is contained in:
Craig Condon
2011-11-26 13:22:10 -06:00
commit ee950f811c
3 changed files with 85 additions and 0 deletions
+2
View File
@@ -0,0 +1,2 @@
[commands]
proj = subl --project project.sublime-project
+60
View File
@@ -0,0 +1,60 @@
## Requirements
- Linux / Mac
## Installation
Via NPM:
```bash
npm install nexe
```
Or git:
```bash
git clone
```
### Features
- Compiled **with** node.js. This allows you to move your executable around *without* needing to install the node.js runtime.
### Motivation
- Developing client-side utilities without requiring to install a bunch of dependencies first (node.js, npm).
- Ability to run multiple node.js applications with *different* node.js runtimes.
### CLI Usage
````text
Commands:
-i the input javascript files
-o the output executable
--runtime the runtime version of node.js to compile with
Examples:
-i input.js -o my-binary --runtime=0.6.2 compile javascript file with node
````
### Code usage
````javascript
var nexe = require('nexe');
nexe.compile('input.js', 'output.bin', function() {
});
````
+23
View File
@@ -0,0 +1,23 @@
{
"folders":
[
{
"path": "."
}
],
"build_systems":
[
{
"name":"cbd make",
"cmd":["cbd","make","nexe"]
},
{
"name":"cbd start",
"cmd":["cbd","start","nexe"]
},
{
"name":"cbd make+start",
"cmd":["cbd","make+start","nexe"]
}
]
}