Skip to content

Commit 80a76aa

Browse files
committed
Update Installation guide
1 parent 0d617e9 commit 80a76aa

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# `chkware` website
22

3-
This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io
3+
This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io.
44

5+
### Installation
56

6-
### Installation [TBD]
7+
Clone the repo:
78

9+
```sh
10+
git clone https://github.com/chkware/chkware.github.io.git
11+
cd chkware.github.io
812
```
9-
$ npm install
13+
14+
Install dependencies:
15+
16+
```sh
17+
npm install
1018
```
1119

1220
### Local Development [TBD]
@@ -30,4 +38,5 @@ This command generates static content into the `build` directory and can be serv
3038
The current status of the website is **under construction**. Please follow us on Twitter [@chkware](https://twitter.com/chkware) for update. Thank you for your patience.
3139

3240
---
33-
`chkware` website uses [docusaurus v2.0.0-beta.17](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.17) as CMS backend.
41+
42+
`chkware` website uses [docusaurus v2.0.0-beta.17](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.17) as CMS backend.

0 commit comments

Comments
 (0)