README.md.tpl

# {{.Manifest.Name}} driver for [Babelfish](https://github.com/bblfsh/bblfshd) ![Driver Status](https://img.shields.io/badge/status-{{.Manifest.Status | escape_shield}}-{{template "color-status" .}}.svg) [![Build Status](https://travis-ci.org/bblfsh/{{.Manifest.Language}}-driver.svg?branch=master)](https://travis-ci.org/bblfsh/{{.Manifest.Language | escape_shield }}-driver) ![Native Version](https://img.shields.io/badge/{{.Manifest.Language}}%20version-{{.Manifest.Runtime.NativeVersion | escape_shield}}-aa93ea.svg) ![Go Version](https://img.shields.io/badge/go%20version-{{.Manifest.Runtime.GoVersion | escape_shield}}-63afbf.svg)

{{if .Manifest.Documentation}}{{.Manifest.Documentation.Description}}

{{if .Manifest.Documentation.Caveats -}}
Caveats
-------

{{.Manifest.Documentation.Caveats}}
{{end -}}{{end -}}


Development Environment
-----------------------

Requirements:
- `docker`
- Go {{.Manifest.Runtime.GoVersion}}+

To initialize the build system execute: `go test ./driver`, at the root of the project. This will generate the `Dockerfile` for this driver.

To run the tests just execute `go run test.go`, this will start the test over the native and the Go components of the driver using Docker.

The build is done executing `go run build.go`. To evaluate the result using a docker container, execute:
`go run build.go test-driver && docker run -it test-driver`.

If the project is located under `$GOPATH`, run all the above with `GO111MODULE=on` environment variable,
or move the project to any other directory outside of `$GOPATH`.

License
-------

GPLv3, see [LICENSE](LICENSE)


{{define "color-status" -}}
{{if eq .Manifest.Status "planning" -}}
e08dd1
{{- else if eq .Manifest.Status "pre-alpha" -}}
d6ae86
{{- else if eq .Manifest.Status "alpha" -}}
db975c
{{- else if eq .Manifest.Status "beta" -}}
dbd25c
{{- else if eq .Manifest.Status "stable" -}}
9ddb5c
{{- else if eq .Manifest.Status "mature" -}}
60db5c
{{- else -}}
d1d1d1
{{- end}}
{{- end}}