From 01042feb602d0445744c958462d35eef1b3be401 Mon Sep 17 00:00:00 2001 From: Sohit Miglani Date: Thu, 3 Sep 2020 13:22:17 -0700 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0f81bb6..2dab19f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,23 @@ We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with ## Run It On Your Machine +### Managing Dependencies + +It may be the case that your system doesn't have the required dependencies. You will need 'cmake' and 'make' installed on your computer. + +* For MacOS, use homebrew to update your dependencies (Install Homebrew from [here](https://brew.sh/)): +```bash +brew install make cmake +``` +* For Linux/Ubuntu, use the apt-get tool to install the dependencies: +```bash +sudo apt-get install make cmake +``` + +### Installing and Running the tool + +Note that the third command (./script/bootstrap) may require you to use 'sudo' access for installation. Add 'sudo' right before the third command, if need be, but don't use root access. + ```bash git clone https://github.com/github/choosealicense.com.git cd choosealicense.com