mirror of
https://github.com/Xevion/calligraphy.git
synced 2025-12-06 05:14:40 -06:00
add README
This commit is contained in:
45
README.md
45
README.md
@@ -1,24 +1,33 @@
|
||||
# calligraphy
|
||||
|
||||
## Project setup
|
||||
```
|
||||
npm install
|
||||
```
|
||||
`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.
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
```
|
||||
npm run serve
|
||||
```
|
||||
## Design
|
||||
|
||||
### Compiles and minifies for production
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
- 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
|
||||
|
||||
### Lints and fixes files
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
## Local Deployment
|
||||
|
||||
### Customize configuration
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).
|
||||
- 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/).
|
||||
|
||||
Reference in New Issue
Block a user