Updated readme

This commit is contained in:
Mark van Renswoude 2020-12-30 23:29:30 +01:00
parent 04d8de192c
commit aca82c477f
1 changed files with 16 additions and 2 deletions

View File

@ -1,8 +1,22 @@
# CuttingBoard
A web-based cutting board designer.
A web-based cutting board designer. Runs fully client-side, designs can be saved by bookmarking the URL or downloading to a JSON file.
## Project setup
If you just want to use it and don't care about the code, go to http://mvrens.github.io/CuttingBoard.
## Features
- Alternate strips on the end grain board, or customize the direction of each strip individually
- Allows for defining multiple boards with their own layer patterns, which can be combined into one end grain cutting board in any order and direction
- Wood species can be added or customized
- Printing support, with options to select what gets printed to save on paper (and use those trees on cutting boards instead!)
- Units in millimeters, centimeters and inches (decimal - fractional is on the ToDo list)
## Developing
This project uses VueJS 3, Vuex and SCSS.
### Project setup
```
npm install
```