From ec4b3155dc921c64e930859518481d9f3dab064d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=20Hoffr=C3=A9n?= Date: Wed, 19 Jul 2023 23:01:00 +0300 Subject: [PATCH 1/2] Update sudo usage instructions in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d38a18..472fd2e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ 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 ): ```bash @@ -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 needed, but don't run the script as root. ```bash git clone https://github.com/github/choosealicense.com.git From c4d7d8226d8001dca31b808be9550e186572b466 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=20Hoffr=C3=A9n?= Date: Thu, 27 Jul 2023 20:12:32 +0300 Subject: [PATCH 2/2] Update sudo usage instructions in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 472fd2e..e78c1fd 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,6 @@ 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 needed, but don't run the script as root. - ```bash git clone https://github.com/github/choosealicense.com.git cd choosealicense.com @@ -40,6 +38,8 @@ cd choosealicense.com 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 For information on adding a license, see [the CONTRIBUTING file](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license).