Update README.md

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: build
+
+on:
+    push:
+        branches:
+        - master
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+          - name: checkout
+            uses: actions/checkout@v2
+    
+          - name: Setup Go
+            uses: actions/setup-go@v2
+            with:
+              go-version: '1.13.0'
+        
+          - name: Build
+            run:  make -j $(nproc) compile
+

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: build release
+name: release
 
 on:
     push:
@@ -10,6 +10,10 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
+          - name: Get the version
+            id:   get_version
+            run:  echo ::set-output name=VERSION::$(echo $GITHUB_REF | cut -d / -f 3)
+            
           - name: checkout
             uses: actions/checkout@v2
     
@@ -19,7 +23,7 @@ jobs:
               go-version: '1.13.0'
         
           - name: Build
-            run:  make -j $(nproc) compile VERSION=${{ github.ref }}
+            run:  make -j $(nproc) compile VERSION=${{ steps.get_version.outputs.VERSION }}
             
           - name: create release
             id:   create_release
@@ -27,8 +31,8 @@ jobs:
             env:
                 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             with:
-                tag_name: ${{ github.ref }}
-                release_name: Release ${{ github.ref }}
+                tag_name: ${{ steps.get_version.outputs.VERSION }}
+                release_name: Release ${{ steps.get_version.outputs.VERSION }}
                 draft: false
                 prerelease: false
                 

Makefile

@@ -17,15 +17,16 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-NAME     = range-gen
+NAME     = $(shell basename $(shell readlink -e .))
 VERSION  = dev_$(shell date +%F_%T)
 GOCMD    = go
 LDFLAGS := "$(LDFLAGS) -X 'main.Version=$(VERSION)'"
 GOBUILD  = $(GOCMD) build -ldflags=$(LDFLAGS)
 SRCMAIN  = ./cmd/$(NAME)
+SRCDOC   = ./doc
 BINDIR   = bin
 BIN      = $(BINDIR)/$(NAME)
-README   = ./doc/README
+README   = $(SRCDOC)/README
 LICENSE  = LICENSE
 PREFIX   = /usr
 
@@ -41,8 +42,8 @@ build: prep
 	$(GOBUILD) -o $(BIN) $(SRCMAIN)
 	
 doc: check-build
-	test -d ./doc || mkdir ./doc
-	$(BIN) --help > ./doc/README
+	test -d $(SRCDOC) || mkdir $(SRCDOC)
+	$(BIN) --help > $(README)
 
 check-build:
 	test -e $(BIN)

README.md

@@ -1 +1,49 @@
-# range-gen
+# Range-Gen
+
+[![build](https://github.com/GenZmeY/range-gen/workflows/build/badge.svg)](https://github.com/GenZmeY/range-gen/actions)
+[![GitHub top language](https://img.shields.io/github/languages/top/GenZmeY/range-gen)](https://golang.org)
+[![GitHub](https://img.shields.io/github/license/genzmey/range-gen)](https://www.gnu.org/licenses/gpl-3.0.en.html)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/GenZmeY/range-gen)](https://github.com/GenZmeY/range-gen/releases)
+
+*range-gen creates a list of scene ranges based on a set of frames from the video. This program is used in the [video2d-2x](https://github.com/GenZmeY/video2d-2x) project.*
+
+***
+
+# Build & Install
+**Note:** You can get the compiled version for your platform on the [release page](https://github.com/GenZmeY/range-gen/releases).
+
+Dependencies:  
+- linux distro
+- git
+- golang 1.13
+- make  
+
+Get the source:  
+`git clone https://github.com/GenZmeY/range-gen`  
+
+Build:  
+`cd range-gen && make`  
+
+Install:  
+`make install`  
+
+**Build versions for all plaforms:**  
+`make -j $(nproc) compile`  
+(executables will be in `range-gen/bin` folder)
+
+# Usage
+```
+Usage: range-gen [option]... <input_dir> <output_file> <threshold>
+input_dir          Directory with png images
+output_file        Range list file
+threshold          Image similarity threshold (0-1024)
+
+Options:
+  -j, --jobs N     Allow N jobs at once
+  -n, --noise      Default noise level for each range (0-3)
+  -h, --help       Show this page
+  -v, --version    Show version
+```
+
+# License
+Range-gen is licensed under the [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html), but uses a [go-perceptualhash](https://github.com/dsoprea/go-perceptualhash) ([BSD 3-Clause License](https://github.com/dsoprea/go-perceptualhash/blob/master/LICENSE)) to calculate hashes of images.

cmd/range-gen/main.go

@@ -167,7 +167,7 @@ func calcRanges(hashes map[string]string, Threshold int) string {
 	var rangeNoise string = ""
 
 	if ArgDefaultNoiseLevel >= 0 {
-		rangeNoise = "\t" + string(ArgDefaultNoiseLevel)
+		rangeNoise = "\t" + strconv.Itoa(ArgDefaultNoiseLevel)
 	}
 
 	names := []string{}