Skip to content

Commit

Permalink
Adds DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
howardwu committed Feb 25, 2021
1 parent d9ec234 commit 9c96390
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/tmp/
**.idea/
*.DS_Store
**/process.yml
31 changes: 31 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 9c96390

Please sign in to comment.