diff --git a/README.md b/README.md index 70ae74a..663a90e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# Stream Awesome - Stream Deck Icon Generator using Font Awesome +## Stream Awesome - Stream Deck Icon Generator using Font Awesome +### > Available online: https://skate702.de/StreamAwesome/ -### Demo available online: https://skate702.de/StreamAwesome/ +Generate awesome looking Stream Deck icons like [these](https://www.instagram.com/p/CKPCM_YF16a/). Close to the [Elgato original](https://www.elgato.com/stream-deck) and of course awesome because of [Font Awesome](https://fontawesome.com/). -Generate awesome looking stream deck icons like [these](https://www.instagram.com/p/CKPCM_YF16a/). Close to the [Elgato original](https://www.elgato.com/stream-deck) and of course awesome because of [Font Awesome](https://fontawesome.com/). Currently, in prototyping phase. ![image](preview.png) ## How to install -1. Clone the repository -2. Download [Font Awesome for the web](https://fontawesome.com/download) 5.6.0 or higher -3. Extract the folder in `prototype` directory of cloned repository -4. Rename extracted folder to `fontawesome` -5. Localhost `./prototype`, e.g., using `npx http-server` +0. Precondition: Install [Node](https://nodejs.org) and npm +1. Clone this repository +2. Download a recent version of [Font Awesome For The Web](https://fontawesome.com/download) +3. Extract the folders `css` and `webfonts` into `StreamAwesome/fonts/fontawesome` +4. Run `npm run dev` from within the `StreamAwesome` folder or use the provided Visual Studio Code config \ No newline at end of file