Add instructions and screenshot to README
This commit is contained in:
parent
47d80a88df
commit
2665128e9e
16
README.md
16
README.md
|
@ -3,3 +3,19 @@
|
|||
This project was an experiment in making a physical looking website.
|
||||
It consists of sticky notes that can be typed on dragged around and removed.
|
||||
It allows more functionality that was not implemented, like adding traditional webpage aspects of navigation on paper and such.
|
||||
|
||||
# Building
|
||||
To build, first install Sass as it's required for the build script.
|
||||
Then install rollup through npm
|
||||
```
|
||||
npm install
|
||||
```
|
||||
Then run
|
||||
```
|
||||
make build
|
||||
```
|
||||
Your computer must have GNU make installed to build this, but it should be pretty simple to assemble it all by hand if you don't.
|
||||
|
||||
Once the build is complete, you will find the webpage files in the `target` directory.
|
||||
|
||||
![Corkboard website with sticky notes and paper](./screenshot.png)
|
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.3 MiB |
Loading…
Reference in a new issue