From c8d425ada243ff3de8df9d834511571dd32c08aa Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Tue, 15 Mar 2016 12:10:27 -0400 Subject: [PATCH] add a README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..ef80adcde --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# LBRY Web User Interface + +This is the frontend for LBRY's in-browser application, that is automatically installed when a user installs [LBRY](https://github.com/lbryio/lbry). + +## Development Setup + +These steps will get you to change-reload-see: + +- Install [LBRY](//github.com/lbryio/lbry) +- Install node and npm ([this gist may be useful](https://gist.github.com/isaacs/579814)) +- Install babel (`npm install -g babel-cli babel-preset-es2015 babel-preset-react`) +- Install [SASS](http://sass-lang.com/install) +- Run ./watch.sh +- Open index.html +- Changes made in `js` and `sass` will be auto compiled to `dist`