xevion/calligraphy
1
0
Fork 0
mirror of https://github.com/Xevion/calligraphy.git synced 2025-12-06 01:14:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

add README

Browse Source
This commit is contained in:
Xevion
2020-08-20 16:42:42 -05:00
parent d2fb367420
commit c221483829
1 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -1,24 +1,33 @@
# calligraphy # calligraphy
## Project setup `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
npm install generated sheets on the fly.
```
### Compiles and hot-reloads for development ## Design
```
npm run serve
```
### Compiles and minifies for production - Pages are dynamically generated by the browser. No backend needed.
``` - Fonts are dynamically fetched and loaded from Google's Font API
npm run build - 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
### Lints and fixes files ## Local Deployment
```
npm run lint
```
### Customize configuration - Project setup
See [Configuration Reference](https://cli.vuejs.org/config/). - `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/).