From b28eec63426b046cc86eb18cb78237423991885a Mon Sep 17 00:00:00 2001 From: Matei Adriel Date: Thu, 11 Jul 2019 21:05:33 +0300 Subject: [PATCH] added docs to readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 60b0ae0..a5ad85a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # logicGateSimulator2 + a better version of my logic gate simulator Check out the [demo](https://mateiadrielrafael.github.io/logicGateSimulator/) +Or read the [docs](./docs/main.md) (work in progess) To run locally clone this repo, and then run: `npm install` to install all dependenices, `npm run dev` to start the development server or `npm run build` to bundle it. This project wouldnt have been possible without the follownig libraries: -- [typescript](https://github.com/microsoft/TypeScript) and [sass](https://github.com/sass/sass) -- [lit-html](https://github.com/Polymer/lit-html) , [lit-rx](https://github.com/Dabolus/lit-rx) and [rxjs](https://github.com/ReactiveX/rxjs) -- [material components for the web](https://github.com/material-components/material-components-web) -- [webpack](https://github.com/webpack/webpack) -- [gh-pages](https://github.com/tschaub/gh-pages) -- [eix-js](https://github.com/eix-js) + +- [typescript](https://github.com/microsoft/TypeScript) and [sass](https://github.com/sass/sass) +- [lit-html](https://github.com/Polymer/lit-html) , [lit-rx](https://github.com/Dabolus/lit-rx) and [rxjs](https://github.com/ReactiveX/rxjs) +- [material components for the web](https://github.com/material-components/material-components-web) +- [webpack](https://github.com/webpack/webpack) +- [gh-pages](https://github.com/tschaub/gh-pages) +- [eix-js](https://github.com/eix-js) I used lit-html, lit-rx and rxjs mainly for the rendering, MCW for the styling, webpack for bundling, gh-pages for deploying and eix-js (a game engine me and a friend are working on) for input handling and common decorators.