Skip to content

Commit

Permalink
Improved GitHub README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Jan 21, 2024
1 parent c187988 commit db09cff
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,31 +39,31 @@ Otherwise, download the binary form from [here](https://github.com/nthnn/Qrepo/r

## Command

1. `init`: Initialize the current directory as a Qrepo repository project.
- `init`: Initialize the current directory as a Qrepo repository project.
Example:
```bash
qrepo init
```

2. `run`: Run a defined script in the project folder.
- `run`: Run a defined script in the project folder.
Example:
```bash
qrepo run build
```

3. `log`: Display detailed information on the current repository.
- `log`: Display detailed information on the current repository.
Example:
```bash
qrepo log
```

4. `x`: Executes a script from specified URL.
- `x`: Executes a script from specified URL.
Example:
```bash
qrepo x https://raw.githubusercontent.com/nthnn/Qrepo/master/support/install.sh
```

5. `help`: Show help message for a specific command.
- `help`: Show help message for a specific command.
Example:
```bash
qrepo help
Expand Down Expand Up @@ -101,15 +101,21 @@ For instance, you run `qrepo run greet` on Linux with i386, it will print the `H
## GitHub Actions
If your project uses Qrepo for building and/or for other purposes, you can just add the Qrepo installation as a step:
If your project utilizes Qrepo for building or other functions, simply include the Qrepo installation by adding the following step to your GitHub CI/CD workflow pipeline:
```yaml
...
- uses: actions/setup-go@v4
with:
go-version: '1.21.2'
- name: Install Qrepo
run: sh -c "$(curl -fsSL https://raw.githubusercontent.com/nthnn/Qrepo/master/support/install.sh)"
...
```
Utilizing the official Golang GitHub action is essential to bypass the need for brew or apt installations. Also, please note that this step is specifically designed for GitHub CI/CD workflow pipelines and is applicable only to Ubuntu and macOS builds.
## Used By
Below is the list of projects using the Qrepo as package manager and build command line tool.
Expand Down

0 comments on commit db09cff

Please sign in to comment.