Adds DEVELOPMENT.md

This commit is contained in:
howardwu 2021-02-24 20:28:27 -08:00
parent d9ec234840
commit 9c96390505
2 changed files with 32 additions and 0 deletions

1
.gitignore vendored
View File

@ -2,3 +2,4 @@
/tmp/
**.idea/
*.DS_Store
**/process.yml

31
DEVELOPMENT.md Normal file
View File

@ -0,0 +1,31 @@
# Development Guide
## Running CircleCI locally
### Step 1: Install CircleCI
If you wish to run CircleCI locally, start by installing it:
- macOS
```
brew install circleci
```
- Linux (via Snap)
```
sudo snap install docker circleci
sudo snap connect circleci:docker docker
```
- Windows (via Chocolatey)
```
choco install circleci-cli -y
```
### Step 2: Run CircleCI
To run a job, export the config to `process.yml`, and specify it when executing:
```shell
circleci config process .circleci/config.yml > process.yml
circleci local execute -c process.yml --job JOB_NAME
```