aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index f4748c5..f63b0d2 100644
--- a/README.md
+++ b/README.md
@@ -96,19 +96,20 @@ This repository uses a custom commit script `commit.sh` to commit changes. This
> **Note**: If a non-existent branch is specified, the script will ask if you want to create the branch, and if you do, it will create the branch and push it to the remote repository; otherwise, it will abort.
-Before running the script, make sure you have `git` installed and configured and that you have the correct permissions to push to the remote repository. Then you can start by making the script executable first:
+Then you can run the script:
```bash
-chmod +x commit.sh
+commit README.md -m "Update README.md" -t "docs" -b "main"
```
-Then you can run the script:
+Before running the command, make sure you have `git` installed and configured and that you have the correct permissions to push to the remote repository.
+If you haven't configured aliases or run `setup.py` at this point, you can achieve the same by making the script executable first:
```bash
-commit README.md -m "Update README.md" -t "docs" -b "main"
+chmod +x commit.sh
```
-If you haven't configured aliases at this point, you can achieve the same by running:
+Commit the changes:
```bash
./commit.sh README.md -m "Update README.md" -t "docs" -b "main"