fix(cli): added mkidr -p's for when output doesn't exist, updated readme

Author: TristanWright

README.md

@@ -6,14 +6,16 @@ To provide a simple way to write input simpulation files.
 
 ## Installation
 
-```
+```sh
 $ npm install -g simput
 ```
 
+## Usage
+
 After installing the package you will get one executable **Simput** with
 the following set of options:
 
-```
+```sh
 $ Simput
 
   Usage: Simput [options]
@@ -37,37 +39,58 @@ $ Simput
 
 ```
 
-## Development
+### Examples
 
 ```sh
-$ git clone https://github.com/Kitware/tonic.git
-$ cd tonic
-$ npm run global
-$ npm install
-$ cd tonic-applications/simput
+$ Simput -t pyfr -o ~/pyfr/example
 ```
 
-## Production
-
-```
-$ git clone https://github.com/Kitware/simput.git
-$ cd simput
-$ git submodule update --init
-$ npm install
-$ npm link
+Starts a server and opens your Web browser, an empty PyFR model is loaded which you can modify.
+The _Save_ button will export a pyfr.json file (model) which you can then be loaded later on.
+The _Convert_ button will export a `pyfr.ini` file for PyFR execution.
+
+As no initial model was provided, the boundary names will be autogenerated.
+In order to pre-define those boundary names, you can either edit the generated model (pyfr.json) or
+start with an empty model you've created like the following one.
+
+my-pyfr-model.json
+```js
+{
+    "type": "pyfr",
+    "data": {},
+    "external": {
+        "boundary-names": {
+            "User friendly name": "value-expected-by-code",
+            "Inlet": "inlet",
+            "Outlet": "outlet",
+            "External walls": "external-wall"
+        }
+    }
+}
 ```
 
-### Uninstall
-In the folder you ran npm link from:
-```
-$ npm unlink
+Then loading it back for further edits can be performed with the following command line:
+
+
+```sh
+$ Simput -i my-pyfr-model.json -o ~/pyfr/example
 ```
-N.B: npm version >=2.4.1 is recommended for this or else you'll get an error and a warning.
 
-## Demos
+### Demos
 
 There are a few supplied demos in the folder `types`, each have their own README.
 
+## Development
+
+```sh
+$ git clone https://github.com/Kitware/tonic.git
+$ cd tonic
+$ npm run global
+$ npm install
+$ cd tonic-applications/simput
+$ npm link
+```
+
 #### Licensing
 
 **Simput** is licensed under [BSD Clause 3](LICENSE).

bin/converter.js

@@ -1,3 +1,5 @@
+require('shelljs/global');
+
 var fs = require('fs'),
     path = require('path'),
     home = process.env.HOME,
@@ -20,7 +22,7 @@ function unitSuffix(size) {
         if (size < keys[i]) {
             return size / Math.pow(10, Math.log10(keys[i])-3) + suffixes[keys[i]];
         }
-    } 
+    }
     return size;
 }
 
@@ -30,15 +32,15 @@ module.exports = function (input, outputDirectory) {
     var inputContents = JSON.parse(
         fs.readFileSync(input, {encoding: 'utf8'})
     );
-    
+
     // import corresponding input type
     var type = inputContents.type;
     require(path.join(simputFolder, type + '.js'));
-    
+
     // write output
     try {
         var output = GLOBAL.Simput.types[type].convert(inputContents);
-        outputDirectory = toAbsolutePath(outputDirectory); 
+        outputDirectory = toAbsolutePath(outputDirectory);
         Object.keys(output.results).forEach(function(el) {
             fs.writeFileSync(path.join(outputDirectory, el), output.results[el]);
             var size = fs.statSync(path.join(outputDirectory, el)).size;

bin/simput-cli.js

@@ -53,8 +53,10 @@ if (!process.argv.slice(2).length) {
 
 // inout
 if (program.input && program.output && !program.gui) {
+  mkdir('-p', toAbsolutePath(program.output));
   simputConverter(program.input, program.output);
 } else if (program.compile) {
+  mkdir('-p', toAbsolutePath(program.output));
   simputCompiler(toAbsolutePath(program.compile), program.type, program.output);
 } else if (program.output) {
   const app = express();
@@ -106,7 +108,7 @@ if (program.input && program.output && !program.gui) {
     })
     .post(function(req, res) {
       //receive new file content and update the file at program.input
-      console.log('POST', req.body);
+      mkdir('-p', toAbsolutePath(program.output));
       for (var key in req.body) {
         fs.writeFileSync(path.join(program.output, key), req.body[key]);
       }