docs/choosealicense.com
docs/choosealicense.com
1
0
Fork 0
mirror of https://github.com/github/choosealicense.com synced 2024-12-22 12:50:24 +01:00
Code Issues Releases Wiki Activity

Merge pull request #765 from sohitmiglani/gh-pages

Browse Source 
Added documentation for installing dependencies and edge case with 'sudo' access in MacOS
This commit is contained in:
Mike Linksvayer 2020-09-03 15:02:44 -07:00 committed by GitHub
commit e639900fbc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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 <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