dynamically populate sample list + update readme

Author: devhawk

Foyfile.js

@@ -4,6 +4,15 @@ var nbgv = require('nerdbank-gitversioning')
 
 setGlobalOptions({ loading: false }) 
 
+// build a list of all the samples from the samples directory
+const sampleDir = path.posix.join(__dirname, "samples")
+const samples = fs.readdirSync(sampleDir)
+  .filter(x => !x.startsWith("_"))
+  .map(x => path.join(sampleDir, x))
+  .filter(x => fs.statSync(x).isDirectory())
+  .map(x => path.basename(x))
+
+
 task('setversion', async ctx => {
   const compilerPath = path.join(__dirname, "packages", "compiler")
   const fxPath = path.join(__dirname, "packages", "framework")
@@ -24,13 +33,6 @@ task('clean', async ctx => {
   await ctx.exec('git clean -dxf', { cwd: path.join(__dirname, "samples") });
 })
 
-const samples = [
-  "helloworld", 
-  "nep11token", 
-  "nep17token", 
-  // "registrar"
-];
-
 async function buildSample(ctx, sample) {
   const cwd = path.join(__dirname, "samples", sample);
   const compilerPath = path.posix.join(__dirname, "packages/compiler/lib/main.js").replace(/\\/g, '/');

README.md

@@ -1,6 +1,7 @@
 # neo-devpack-ts
 
-*under active development*
+> Note, this project is under active development. It is not yet packaged as a stand alone tool.
+> If you wish to try it with your own contract, please see the [Samples](#samples) section below.
 
 ## Requirements
 
@@ -14,4 +15,24 @@
 * `npm run build`: compiles the devpack
 * `npm run clean`: cleans the build output
 * `npm run samples`: compiles the devpack and builds the sample contracts
+* `npx foy <sample name>`: builds the specified sample contract and runs the associated express.batch file if available
+
+## Samples
+
+The `foy` task runner dynamically generates the samples to build from the contents of the `samples` directory. 
+Any subdirectory of `samples` that doesn't start with an underscore is considered a sample.
+Each sample directory must contain a contract `.ts` file matching the name of the directory.
+If the sample directory contains an `express.batch` file, it will be run automatically after the contract is built.
+
+### Hello World
+
+Simple contract that stores a byte string in contract storage and returns it when called.
+
+### Tank NEP-17 Token
+
+Implements a sample [NEP-17](https://github.com/neo-project/proposals/blob/master/nep-17.mediawiki) fungible token contract
+
+### Hovercraft NEP-11 Token
+
+Implements a sample [NEP-11](https://github.com/neo-project/proposals/blob/master/nep-11.mediawiki) non fungible token contract