Update README.md
This commit is contained in:
parent
e286a83c26
commit
94720527bd
18
README.md
18
README.md
|
@ -1,17 +1,29 @@
|
||||||
# [Cardiff BJJ website][4]
|
# Cardiff BJJ
|
||||||
|
|
||||||
|
Website for the [Rob Taylor Jiu-Jitsu Academy][4].
|
||||||
|
|
||||||
Built with [Sculpin][0] and [Tailwind CSS][1] by [Oliver Davies][2].
|
Built with [Sculpin][0] and [Tailwind CSS][1] by [Oliver Davies][2].
|
||||||
Hosted on [Netlify][3].
|
Hosted on [Netlify][3].
|
||||||
|
|
||||||
## Install
|
## Prerequisites
|
||||||
|
|
||||||
|
- PHP
|
||||||
|
- Composer
|
||||||
|
- Yarn
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ composer install
|
git clone https://github.com/cardiff-bjj/website cardiff-bjj
|
||||||
|
cd cardiff-bjj
|
||||||
|
composer install
|
||||||
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
yarn watch
|
||||||
vendor/bin/sculpin generate --watch --server
|
vendor/bin/sculpin generate --watch --server
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Reference in a new issue