Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EliteAsian123 authored Jul 14, 2022
1 parent 23fb392 commit 5287f8f
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,22 @@ An animated wallpaper for Lively Wallpaper based on [Lively Matrix](https://gith
Please refer to the [releases section](https://github.com/EliteAsian123/MatrixWallpaper/releases/) and read the instructions on the lastest release.

# Building
Run the following:
> **Warning**
>
> Komorebi requires the use of a URL instead of an HTML file. The built Komorebi wallpaper uses a reference to
> [this](https://eliteasian123.github.io/MatrixWallpaper/src/), **not** the `src` folder.
>
> If you want to test out your own version of this wallpaper on Komorebi, I recommend creating a [Github Pages](https://pages.github.com/) website like I did.
```bash
$ git clone https://github.com/EliteAsian123/MatrixWallpaper.git
$ npm install

$ npm run buildLively # For Lively Wallpaper
$ npm run buildKomorebi # For Komorebi (Fork)
```

# Contributing
Go ahead :)

As for testing, making sure the `index.html` file works should be enough.

0 comments on commit 5287f8f

Please sign in to comment.