Skip to content

Commit

Permalink
Update README for release of v1.
Browse files Browse the repository at this point in the history
  • Loading branch information
sebinside committed Feb 4, 2024
1 parent ecae4af commit 1498219
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1498219

Please sign in to comment.