fix(docs): add checking out project
- edits inaccurate directions in Mac OS - adds section for checking out the project
This commit is contained in:
parent
f00dcb9ca7
commit
2bdd9d4b61
2
Makefile
2
Makefile
|
@ -124,7 +124,7 @@ deploy:
|
|||
$(TARGET_PATH) s3://$(DEPLOY_BUCKET)
|
||||
|
||||
test: ## run mocha unit tests
|
||||
test: test-cover
|
||||
test: test-check
|
||||
|
||||
test-check: ## run mocha unit tests with coverage reports
|
||||
$(NODE_BIN)/nyc $(COVER_OPTS) \
|
||||
|
|
21
docs/dev.md
21
docs/dev.md
|
@ -7,6 +7,7 @@
|
|||
- [Setup](#setup)
|
||||
- [Linux](#linux)
|
||||
- [Mac OS](#mac-os)
|
||||
- [Checking Out the Project](#checking-out-the-project)
|
||||
- [Building](#building)
|
||||
- [Compiling Typescript](#compiling-typescript)
|
||||
- [Running Mocha Tests](#running-mocha-tests)
|
||||
|
@ -47,7 +48,7 @@ Install `brew`:
|
|||
Install `make`, `node`, and `yarn`:
|
||||
|
||||
```shell
|
||||
> brew install --with-default-names make
|
||||
> brew install make
|
||||
> brew install node yarn
|
||||
```
|
||||
|
||||
|
@ -55,6 +56,24 @@ Install `make`, `node`, and `yarn`:
|
|||
- https://formulae.brew.sh/formula/node
|
||||
- https://classic.yarnpkg.com/en/docs/install/#mac-stable
|
||||
|
||||
## Checking Out the Project
|
||||
|
||||
Clone the repository:
|
||||
|
||||
```shell
|
||||
> git clone git@github.com:ssube/cautious-journey.git
|
||||
```
|
||||
|
||||
You can also clone the repository through Github Desktop:
|
||||
|
||||
* [x-github-client://openRepo/https://github.com/ssube/cautious-journey](x-github-client://openRepo/https://github.com/ssube/cautious-journey)
|
||||
|
||||
Change the directory:
|
||||
|
||||
```shell
|
||||
> cd ~/Documents/GitHub/cautious-journey/
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
Building the app is done through `make` and its targets. To see a list of available targets:
|
||||
|
|
Loading…
Reference in New Issue