Prepare first gh release (0.1.0)

Author: gustavothecoder

Makefile

@@ -1,16 +1,18 @@
 CC = gcc
 CC_FLAGS = -g -o
-GH_PATH=~/.local/bin/gh
-MAN_PATH=~/.local/man/man1/gh.1
+GH_DIR=~/.local/bin
+MAN_DIR=~/.local/man/man1
 
 build_tests:
 	$(CC) $(CC_FLAGS) tests.out ./tests/*.c ./src/gh.c -lcmocka -Wl,--wrap=find_git_config -DTESTING
 install:
-	$(CC) $(CC_FLAGS) $(GH_PATH) ./src/*.c
-	cp ./docs/gh.1 $(MAN_PATH)
-	gzip $(MAN_PATH)
+	mkdir -p $(GH_DIR)
+	mkdir -p $(MAN_DIR)
+	$(CC) $(CC_FLAGS) $(GH_DIR)/gh ./src/*.c
+	cp ./docs/gh.1 $(MAN_DIR)/gh.1
+	gzip $(MAN_DIR)/gh.1
 uninstall:
-	rm -f $(GH_PATH)
-	rm -f $(MAN_PATH).gz
+	rm -f $(GH_DIR)/gh
+	rm -f $(MAN_DIR)/gh.1.gz
 clean:
 	rm -f ./*.out

README.md

@@ -0,0 +1,54 @@
+# gh
+
+gh is a minimal alternative to GitHub CLI. It allows you to rapidly open the repository page, list PRs waiting for review, open new PRs, etc.
+
+## Summary
+```bash
+# Opens the repository page
+$ gh
+
+# Opens the pull request page of the current repository
+$ gh pulls
+
+# Opens the pull request page, but only your closed PRs are listed
+$ gh pulls --closed \
+           --author=@me
+
+# Opens the pull request page, but only PRs awaiting review from you are listed
+$ gh pulls --to-review
+
+# Opens the pull request form filling some fields
+$ gh newpr --dest-src=main..my-branch \
+           --template=feature.md \
+           --title=I implemented a very nice feature \
+           --assignees=gustavothecoder \
+           --labels=feature,minor
+```
+
+## Installation
+
+### Dependencies
+
+You need to be able to compile C code. Installing `build-essential` for Debian-based distros or `base-devel` for Arch-based distros should be sufficient.
+
+Right now FireFox is a dependency too.
+
+### Steps
+
+Just run:
+```bash
+$ make install
+```
+
+To uninstall:
+```bash
+$ make uninstall
+```
+
+## Usage
+
+Run `gh help` or read the manpage [right here](./docs/ascii_man).
+
+## Contributing
+
+Bug reports and pull requests are welcome :)

docs/ascii_man

@@ -0,0 +1,85 @@
+gh(1)                            User commands                           gh(1)
+
+
+
+NNAAMMEE
+       gh - A minimal alternative to GitHub CLI.
+
+
+DDEESSCCRRIIPPTTIIOONN
+       gh  is  a  CLI  that works as an interface to github.com. It requires a
+       browser for that and right now only Firefox is supported.
+
+
+SSYYNNOOPPSSIISS
+       gh [COMMANDS] [OPTIONS]
+
+
+CCOOMMMMAANNDDSS
+       gh-help
+              Prints help.
+
+
+       gh-repo
+              Open the repository page. When no option is provided, this  com-
+              mand is used by default.
+
+
+       gh-pulls
+              Open the pull request page of the current repository.
+
+
+       gh-newpr
+              Open a pull request for the current repository.
+
+
+GGHH--PPUULLLLSS OOPPTTIIOONNSS
+       --open Only list open pull requests.
+
+
+       --closed
+              Only list closed pull requests.
+
+
+       --author=<value>
+              Filter  pull  requests by author. `@me` works as an alis to your
+              Github username.
+
+
+       --to-review
+              Filter pull requests awaiting review from you.
+
+
+GGHH--NNEEWWPPRR OOPPTTIIOONNSS
+       --dest-src=<dest_branch>...<src_branch>
+              Select the destination branch and the source branch.
+
+
+       --template=<value>
+              Select the template to be used in the PR description.
+
+
+       --title=<value>
+              Define the PR title.
+
+
+       --assignees=<value1>,<value2>,<valueN>
+              Define the PR assignees.
+
+
+       --labels=<value1>,<value2>,valueN>
+              Define the PR labels.
+
+
+FFIILLEESS
+       _~_/_._l_o_c_a_l_/_b_i_n_/_g_h
+
+       _~_/_._l_o_c_a_l_/_m_a_n_/_m_a_n_1_/_g_h_._1_._g_z
+
+
+AAUUTTHHOORR
+       Gustavo Ribeiro ([email protected])
+
+
+
+0.1.0                             07 Mar 2024                            gh(1)

docs/gh.1

@@ -1,4 +1,4 @@
-.TH gh 1 "02 Mar 2024" "0.1.0" "User commands"
+.TH gh 1 "07 Mar 2024" "0.1.0" "User commands"
 
 .SH NAME
 gh \- A minimal alternative to GitHub CLI.

scripts/update_ascii_man.sh

@@ -0,0 +1,4 @@
+rm -f ./docs/ascii_man
+touch ./docs/ascii_man
+cat ./docs/gh.1 | groff -mandoc -T ascii > ./docs/ascii_man
+