diff --git a/README.md b/README.md index 0e2ecbe..26a8f99 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ Fractals ======== -This is a playground for fractals. Here is how the result currently looks: +This is a playground for fractals. A live version is hosted at https://infinity.synoikos.de/fractals/ ![Image of current rendering.](Example.svg) -# Dev +# Setup -Install `typescript` and `tslint` globally, if you haven't aready. +Install `typescript` and `tslint` globally, if you haven't already. ```bash npm install -g typescript tslint ``` @@ -16,17 +16,18 @@ npm install ``` +Link to global typescript: +```bash +npm link typescript +``` + ## Build Compile TypeScript to JavaScript. ```bash -tsc +npm run build ``` -Executing this in the application's root folder will apply the settings from `tsconfig.json`. ## Run -Run the application from the project's root folder. -```bash -node dist/app.js -``` +Open `./public/index.html` in your favourite browser.