Skip to content

Commit

Permalink
add manpage (Fix #8)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Dec 31, 2018
1 parent e06e558 commit dc957bf
Show file tree
Hide file tree
Showing 5 changed files with 573 additions and 3 deletions.
1 change: 1 addition & 0 deletions .appveyor.yml
Expand Up @@ -45,6 +45,7 @@ before_deploy:
- copy target\release\git-brws.exe staging
- copy README.md staging
- copy LICENSE.txt staging
- copy git-brws.1 staging
- cd staging
# release zipfile will look like 'git-brws-1.2.3-x86_64-pc-windows-msvc'
- 7z a ../git-brws-%APPVEYOR_REPO_TAG_NAME%-%TARGET%.zip *
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Expand Up @@ -53,7 +53,7 @@ before_deploy:
- export PKG_CONFIG_ALLOW_CROSS=1
- cargo build --target $TARGET --release
- mkdir "git-brws-${TRAVIS_TAG}-${TARGET}"
- cp target/$TARGET/release/git-brws LICENSE.txt README.md "git-brws-${TRAVIS_TAG}-${TARGET}"
- cp target/$TARGET/release/git-brws LICENSE.txt README.md git-brws.1 "git-brws-${TRAVIS_TAG}-${TARGET}"
- zip "git-brws-${TRAVIS_TAG}-${TARGET}.zip" -r "git-brws-${TRAVIS_TAG}-${TARGET}"

deploy:
Expand Down
18 changes: 16 additions & 2 deletions README.md
Expand Up @@ -4,8 +4,8 @@ git brws
[![Linux and macOS CI][travis-badge]][travis-ci]
[![Windows CI][appveyor-badge]][appveyor]

`git brws` is a command line tool to open a repository, file, commit, diff or pull request in your web
browser from command line. 'brws' is an abbreviation of 'browse'.
`git brws` is a command line tool to open a repository, file, commit, diff, pull request or issue in
your web browser from command line. 'brws' is an abbreviation of 'browse'.

Features:

Expand Down Expand Up @@ -39,6 +39,12 @@ $ cargo install git-brws
You can download a binary executable from [release page][] for macOS, Linux (x86\_64, i686) and Windows
(64bit, 32bit). Unarchive downloaded file and put the executable in `$PATH`.

Manpage for `man` command is available. Please find `git-brws.1` in the unarchived directory or download
it from [here](https://raw.githubusercontent.com/rhysd/git-brws/master/git-brws.1) and copy it to the
`man` directory in your system (e.g. `/usr/local/share/man/man1/`).

Note: `git brws --help` only works when it is installed.

## Usage

```
Expand Down Expand Up @@ -241,6 +247,14 @@ git checkout -b new-branch
git push -u origin new-branch --no-verify
```

To update manpage file `git-brws.1`, please edit `git-brws.1.ronn` and generate `git-brws.1`
automatically with `ronn` command.

```sh
gem install ronn
ronn git-brws.1.ronn
```

[GitHub Project]: https://github.com/rhysd/git-brws
[Crate Badge]: https://img.shields.io/crates/v/git-brws.svg
[travis-ci]: https://travis-ci.org/rhysd/git-brws
Expand Down

0 comments on commit dc957bf

Please sign in to comment.