update README, add yarn lock & package.json

This commit is contained in:
Xevion
2020-12-13 17:51:54 -06:00
parent 4bc226713a
commit 992ecafc09
3 changed files with 65 additions and 34 deletions

View File

@@ -1,38 +1,23 @@
# calligraphy
# power-math
`calligraphy` is a project made to generate calligraphy practice sheets. Each sheet generated
focuses on a specific font (provided by Google Fonts), allowing users to download dynamically
generated sheets on the fly.
I'm not as quick with simple numerical math as I like, so I designed this.
## Design
**power-math** is a project dedicated to those who want to practice random math problems from simple arithmetic to geometry, algebra, or trigonometry.
- Pages are dynamically generated by the browser. No backend needed.
- Fonts are dynamically fetched and loaded from Google's Font API
- Fonts are converted to base64 and placed in the PDF as needed.
- Page sentences can be dynamically generated as needed, or typed in by users
- Customizable
- Font Family
- Font Color
- Font Opacity
- Font Size
- Guideline Opacity
- Guideline Color
- Guideline Style
## Method
### To-do
Vue.js is used to manage all of the UI. Material Design is the CSS framework used to design this
web application.
## Local Deployment
- Project setup
- `npm install`
- Compiles and hot-reloads for development
- `npm run serve`
- Compiles and minifies for production
- `npm run build`
- Lints and fixes files
- `npm run lint`
- Customize configuration
- See [Configuration Reference](https://cli.vuejs.org/config/).
- Create logo
- Transition off of Python backend
- Create new javascript question generation
- Create more problems
- Add question answering & validation
- Decide method of showing it
- Checkmark
- Edge flash
- Toast
- Remember statistics
- Milestone toasts
- Problem difficulty variation
- Variable multiplier
- Time limit
- Customizable question type pool