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 #1130 from nikohoffren/update-instructions

Browse Source 
Update sudo usage instructions in README.md
This commit is contained in:
Mike Linksvayer 2023-07-30 15:46:58 -07:00 committed by GitHub
commit 2c161a8dd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -16,7 +16,7 @@ We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with
### Managing Dependencies ### 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 <https://brew.sh/>): For MacOS, use Homebrew to update your dependencies (install Homebrew from <https://brew.sh/>):
```bash ```bash
@ -29,8 +29,6 @@ sudo apt-get install make cmake
### Installing and Running the tool ### 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 ```bash
git clone https://github.com/github/choosealicense.com.git git clone https://github.com/github/choosealicense.com.git
cd choosealicense.com cd choosealicense.com
@ -40,6 +38,8 @@ cd choosealicense.com
Open `http://localhost:4000` in your favorite browser. Open `http://localhost:4000` in your favorite browser.
If you encounter any issues with the above steps, please refer to the official [Jekyll](https://jekyllrb.com/docs/) documentation and this [guide on running Jekyll as a non-superuser](https://jekyllrb.com/docs/troubleshooting/#no-sudo) for more detailed installation instructions.
## Adding a license ## Adding a license
For information on adding a license, see [the CONTRIBUTING file](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). For information on adding a license, see [the CONTRIBUTING file](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license).