This repository has been archived by the owner on May 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #47 from thislooksfun/feature/update-readme
Update README.md
- Loading branch information
Showing
1 changed file
with
27 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,35 @@ | ||
| # earthdawn | ||
| <!-- Some icon --> | ||
| <!-- <p align="center"> | ||
| <a href=""><img src="" width="" alt="" /></a> | ||
| </p> --> | ||
| <!-- <h3 align="center"><a href="https://probot.github.io">Earthdawn Character Sheet</a></h3> --> | ||
| <h1 align="center">Earthdawn Character Sheet</h3> | ||
| <p align="center">A simple digital character sheet for Earthdawn<p> | ||
| <p align="center"> | ||
| <a href="https://greenkeeper.io"><img src="https://badges.greenkeeper.io/thislooksfun/earthdawn.svg?style=flat-square" alt="greenkeeper: enabled"></a> | ||
| <a href="https://mergify.io"><img src="https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/thislooksfun/earthdawn&style=flat-square" alt="mergify: enabled"></a> | ||
| <a href="https://github.com/thislooksfun/earthdawn/blob/master/LICENSE"><img src="https://flat.badgen.net/github/license/thislooksfun/earthdawn" alt="license"></a> | ||
| <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square" alt="code style: prettier"></a> | ||
| </p> | ||
|
|
||
| [](https://greenkeeper.io/) | ||
| <p align="center"> | ||
| <a href="https://github.com/thislooksfun/earthdawn/releases"><img src="https://flat.badgen.net/github/release/thislooksfun/earthdawn" title="Latest Release" alt="Latest Release"></a> | ||
| <a href="https://github.com/thislooksfun/earthdawn/releases/latest"><img src="https://flat.badgen.net/github/release/thislooksfun/earthdawn/stable" title="Latest Stable Release" alt="Latest Stable Release"></a> | ||
| <img src="https://flat.badgen.net/github/status/thislooksfun/earthdawn" alt="Status"> | ||
| <a href="https://codecov.io/gh/thislooksfun/earthdawn/"><img src="https://badgen.now.sh/codecov/c/github/thislooksfun/earthdawn" alt="Codecov"></a> | ||
| </p> | ||
|
|
||
| [![Mergify Status][mergify-status]][mergify] | ||
| # Development | ||
|
|
||
| ## Project setup | ||
| ## Installation | ||
|
|
||
| ``` | ||
| npm install | ||
| ``` | ||
|
|
||
| ### Compiles and hot-reloads for development | ||
|
|
||
| ``` | ||
| npm run serve | ||
| ``` | ||
|
|
||
| ### Compiles and minifies for production | ||
|
|
||
| ``` | ||
| npm run build | ||
| ``` | ||
|
|
||
| ### Run your tests | ||
| 1. Clone this project | ||
| 2. Run `npm install` | ||
|
|
||
| ``` | ||
| npm run test | ||
| ``` | ||
|
|
||
| ### Lints and fixes files | ||
|
|
||
| ``` | ||
| npm run lint | ||
| ``` | ||
| ## Running | ||
|
|
||
| ### Run your unit tests | ||
| To run locally, run | ||
|
|
||
| ```bash | ||
| npm run electron:serve | ||
| ``` | ||
| npm run test:unit | ||
| ``` | ||
|
|
||
| ### Customize configuration | ||
|
|
||
| See [Configuration Reference](https://cli.vuejs.org/config/). | ||
|
|
||
| <!-- Links --> | ||
|
|
||
| [mergify]: https://mergify.io | ||
| [mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/thislooksfun/earthdawn&style=flat-square |