diff --git a/README.md b/README.md index c040407..c1a0a52 100644 --- a/README.md +++ b/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) \ No newline at end of file diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..a0df1b3 Binary files /dev/null and b/screenshot.png differ