From 01042feb602d0445744c958462d35eef1b3be401 Mon Sep 17 00:00:00 2001 From: Sohit Miglani Date: Thu, 3 Sep 2020 13:22:17 -0700 Subject: [PATCH 1/3] 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 From 849216105e792f71493418dbf76ed9c072754a64 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Thu, 3 Sep 2020 14:39:31 -0700 Subject: [PATCH 2/3] minor formatting --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2dab19f..83a638a 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with 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/)): +* For MacOS, use Homebrew to update your dependencies (install Homebrew from ): ```bash brew install make cmake ``` @@ -29,7 +29,7 @@ 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. +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 From 4bacb32aa7f93ea434b1bb7715ad696821bfb911 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Thu, 3 Sep 2020 14:44:14 -0700 Subject: [PATCH 3/3] more minor formatting --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 83a638a..894937f 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,20 @@ We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with ### 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. +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 ): +For MacOS, use Homebrew to update your dependencies (install Homebrew from ): ```bash brew install make cmake ``` -* For Linux/Ubuntu, use the apt-get tool to install the dependencies: +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. +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