Make README less garbage. Link to GitHub Pages deployment.

This commit is contained in:
Xevion
2020-08-16 20:28:37 -05:00
parent 15516c4d11
commit 88ff40af61

View File

@@ -2,30 +2,29 @@
A small Vue.js based school project exploring a small segment of the history of Robotics.
## Project setup
```
npm install
```
See [History of Robotics](https://xevion.github.io/history-of-robotics/).
### Compiles and hot-reloads for development
```
npm run serve
```
## About
### Compiles and minifies for production
```
npm run build
```
This is a school project, not meant to be a literal article or historically accurate recollection of the Sojourner
and Spirit rovers.
### Run your tests
```
npm run test
```
## GitHub Pages Deployment
### Lints and fixes files
```
npm run lint
```
Deployment to GitHub pages is simple: run `npm run build`, then commit changes with `git add docs`, `git commit` and `git push`.
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
While not a very advanced, recommended nor creative method, it works for me. Look on Google for automated
GitHub Actions-based setups.
## 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/).