Skip to content

Commit 6d6ec91

Browse files
Write good installation instructions
1 parent 723336c commit 6d6ec91

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# Python Requirements License Checker
22

3-
## Instructions
3+
## Installation Instructions
44

5-
To add the license checker to your project, do the following when your console is located in the root of your project in your local computer:
5+
To add the license checker to your project's main branch, assuming your main branch is called `main`, do the following when your console is located in the root of your GitHub project in your local computer:
66

77
```bash
8-
git remote add license-checker github.com/Neuraxio/Python-Requirements-License-Checker
9-
git checkout license-checker
8+
git remote add license-checker [email protected]:Neuraxio/Python-Requirements-License-Checker.git
9+
git fetch --all
10+
git checkout action
1011
git pull license-checker action
11-
git checkout master
12-
git merge action
13-
git push origin master
12+
git checkout main
13+
git merge action --allow-unrelated-histories
14+
git push origin main
1415
```
16+
17+
You may edit the line 4 and 7 of your copy of the file `./.github/workflows/python_license_checker.yml` to change the branch on which the action happen.
18+
19+
You may as well change the checked licenses at lines 13-18 of `./.github/workflows/license_checker_v2.py`.
20+
1521
## Example
1622

17-
You can see an example of the action in the example branch. Do not use the python python_license_checker.yml file in that branch because it has been modified to execute on push and pull request on that specific branch.
23+
You can see an example of the action in the example branch. Do not use the python `python_license_checker.yml` file in that branch because it has been modified to execute on push and pull request on that specific branch only. You can push changes to the `requirements.txt` file of your fork or copy of this example branch to test it and visualize the checks in your project's GitHub UI.

0 commit comments

Comments
 (0)