Merge pull request #56 from golangci/feature/svg-demo

add svg demo

Author: golangci

.goreleaser.yml

@@ -43,7 +43,7 @@ changelog:
     exclude:
     - '^docs:'
     - '^test:'
-    - 'README.md'
+    - 'README'
     - Merge pull request
     - Merge branch
 

.travis.yml

@@ -3,7 +3,7 @@ language: go
 go:
   - 1.9.x
   - 1.10.x
-script: make test
+script: make check_generated test
 
 after_success:
   - test -n "$TRAVIS_TAG" && docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"

Makefile

@@ -7,4 +7,13 @@ test:
 	golangci-lint run --fast --no-config -v ./test/testdata/typecheck.go
 	go test -v -race ./...
 
+assets:
+	svg-term --cast=183662 --out docs/demo.svg --window --width 110 --height 30 --from 2000 --to 20000 --profile Dracula --term iterm2
+
+readme:
+	go run ./scripts/gen_readme/main.go
+
+check_generated:
+	make readme && git diff --exit-code # check no changes
+
 .PHONY: test

README.md

@@ -9,8 +9,8 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
 
 <a href="https://golangci.com/"><img src="docs/go.png" width="250px"></a>
 
-   * [Install](#install)
    * [Demo](#demo)
+   * [Install](#install)
    * [Quick Start](#quick-start)
    * [Comparison](#comparison)
       * [<code>golangci-lint</code> vs <code>gometalinter</code>](#golangci-lint-vs-gometalinter)
@@ -31,6 +31,14 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
    * [Future Plans](#future-plans)
    * [Contact Information](#contact-information)
 
+# Demo
+<p align="center">
+  <img src="./docs/demo.svg" width="100%">
+</p>
+
+Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
+[![asciicast](https://asciinema.org/a/183662.png)](https://asciinema.org/a/183662)
+
 # Install
 Recommended way to install is:
 ```bash
@@ -49,12 +57,6 @@ curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh |
 
 Check the [releases page](https://github.com/golangci/golangci-lint/releases) to fix the version.
 
-# Demo
-Example of output:
-![Screenshot of sample output](docs/run_screenshot.png)
-
-Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
-[![asciicast](https://asciinema.org/a/1a1qaEXMlOSeRyvASbnuFomah.png)](https://asciinema.org/a/1a1qaEXMlOSeRyvASbnuFomah)
 
 # Quick Start
 To run golangci-lint execute:

README.md.tmpl

@@ -9,8 +9,8 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
 
 <a href="https://golangci.com/"><img src="docs/go.png" width="250px"></a>
 
-   * [Install](#install)
    * [Demo](#demo)
+   * [Install](#install)
    * [Quick Start](#quick-start)
    * [Comparison](#comparison)
       * [<code>golangci-lint</code> vs <code>gometalinter</code>](#golangci-lint-vs-gometalinter)
@@ -31,6 +31,14 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
    * [Future Plans](#future-plans)
    * [Contact Information](#contact-information)
 
+# Demo
+<p align="center">
+  <img src="./docs/demo.svg" width="100%">
+</p>
+
+Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
+[![asciicast](https://asciinema.org/a/183662.png)](https://asciinema.org/a/183662)
+
 # Install
 Recommended way to install is:
 ```bash
@@ -49,12 +57,6 @@ curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh |
 
 Check the [releases page](https://github.com/golangci/golangci-lint/releases) to fix the version.
 
-# Demo
-Example of output:
-![Screenshot of sample output](docs/run_screenshot.png)
-
-Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
-[![asciicast](https://asciinema.org/a/1a1qaEXMlOSeRyvASbnuFomah.png)](https://asciinema.org/a/1a1qaEXMlOSeRyvASbnuFomah)
 
 # Quick Start
 To run golangci-lint execute: