diff --git a/.gitignore b/.gitignore index 169d72f25d..825854be0c 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ /tmp/ **.idea/ *.DS_Store +**/process.yml diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000000..357d549c32 --- /dev/null +++ b/DEVELOPMENT.md @@ -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 +```