Alexander/Corkboard
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add instructions and screenshot to README

Browse source
This commit is contained in:
Alexander Bass 2023-04-23 15:58:41 -04:00
parent 47d80a88df
commit 2665128e9e
2 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -3,3 +3,19 @@
This project was an experiment in making a physical looking website. 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 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. 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
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.3 MiB