Skip to content

Commit 6e0dcbe

Browse files
committed
📝 Update README.md and help command comment.
1 parent 74b139e commit 6e0dcbe

File tree

2 files changed

+31
-49
lines changed

2 files changed

+31
-49
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ help:
3333
@echo
3434
@echo "$(GREEN)Options:$(RESET)"
3535
@echo " V=<version> $(BLUE)Specify the base gitmoji version$(RESET)"
36-
@echo " F=<filepath> $(BLUE)Specify semver.yml file path$(RESET)"
36+
@echo " F=<filepath> $(BLUE)Specify .semver.yml file path$(RESET)"
3737
@echo " O=<output dir> $(BLUE)Specify semantic-release setting files output directory$(RESET)"
3838
@echo
3939
@echo "$(GREEN)Examples:$(RESET)"

README.md

Lines changed: 30 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
<!-- code_chunk_output -->
1919

2020
- [Features](#features)
21+
- [How to use in Mac](#how-to-use-in-mac)
22+
- [Install](#install)
23+
- [Usage](#usage)
2124
- [How to use in GithubActions ( only 3 minutes )](#how-to-use-in-githubactions--only-3-minutes-)
2225
- [Step 1: Add `.semver.yml` to your Repository root](#step-1-add-semveryml-to-your-repository-root)
2326
- [Step 2: Add `release.yml` to `.github/workflows/`](#step-2-add-releaseyml-to-githubworkflows)
2427
- [Step 3: Commit and Push](#step-3-commit-and-push)
2528
- [If you want to run locally](#if-you-want-to-run-locally)
26-
- [How to use in Mac](#how-to-use-in-mac)
27-
- [Install](#install)
28-
- [Usage](#usage)
2929
- [Reference](#reference)
3030
- [Author](#author)
3131
- [Show your support](#show-your-support)
@@ -41,6 +41,33 @@
4141
- Automate versioning and release with GithubActions and [semantic-release](https://github.com/semantic-release/semantic-release).
4242

4343

44+
## How to use in Mac
45+
46+
### Install
47+
Require `curl`, `jq`, `yq` and `node` command.
48+
49+
```sh
50+
brew install curl yq jq
51+
52+
yq --version
53+
# yq 2.10.1
54+
jq --version
55+
# jq-1.6
56+
node --version
57+
# v13.14.0 # Probably works in other versions too.
58+
59+
# Install
60+
git clone https://github.com/nkmr-jp/gitmoji-semver
61+
```
62+
63+
### Usage
64+
```sh
65+
cd ./gitmoji-semver
66+
make help
67+
```
68+
69+
<img src="https://user-images.githubusercontent.com/8490118/97778892-c4d51580-1bbd-11eb-9236-c9c676d4337d.png" width=800>
70+
4471
## How to use in GithubActions ( only 3 minutes )
4572

4673
The following steps will automate versioning and releasing with gitmoji using GithubActions.
@@ -140,51 +167,6 @@ brew install act
140167
act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04 # ※ 16GB docker image
141168
```
142169

143-
## How to use in Mac
144-
145-
You can use various commands. It makes it easy to customize settings.
146-
147-
### Install
148-
require `curl`, `jq`, `yq` and `node` command.
149-
150-
```sh
151-
brew install curl yq jq
152-
153-
yq --version
154-
# yq 2.10.1
155-
jq --version
156-
# jq-1.6
157-
node --version
158-
# v13.14.0 # Probably works in other versions too.
159-
160-
# Install
161-
git clone https://github.com/nkmr-jp/gitmoji-semver
162-
```
163-
164-
### Usage
165-
```sh
166-
cd ./gitmoji-semver
167-
make help
168-
169-
# Usage:
170-
# make COMMAND [Options]
171-
#
172-
# Commands:
173-
# gen Generate gitmojis.json with semver field (alias: g)
174-
# list Show generated gitmojis.json (alias: l)
175-
# scaffold Generate semantic-release setting files (alias: s)
176-
#
177-
# Options:
178-
# V=<version> Specify the base gitmoji version
179-
# F=<filepath> Specify semver.yml file path
180-
# O=<output dir> Specify semantic-release setting files output directory
181-
#
182-
# Examples:
183-
# make gen V=v3.0.0 F=./semver.yml
184-
# make list
185-
# make scaffold V=v3.0.0 F=./.semver.yml O=./.playground
186-
```
187-
188170
## Reference
189171

190172
If you want to customize, please refer to the following document.

0 commit comments

Comments
 (0)