Skip to content

Commit

Permalink
[doc] Remove oudated guides in README
Browse files Browse the repository at this point in the history
  • Loading branch information
at15 committed Apr 28, 2019
1 parent e2949fc commit d6c4339
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 35 deletions.
5 changes: 4 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# This Dockerfile is a demo of using go-dev to build a go binary using multi stage build
# It is based on
# https://docs.docker.com/v17.09/engine/userguide/eng-image/dockerfile_best-practices/#use-multi-stage-builds
FROM dyweb/go-dev:1.11.4 as builder
#
# The builder-image go-dev can be found in hack/go-dev
# Versions can be found on https://hub.docker.com/r/dyweb/go-dev/tags
FROM dyweb/go-dev:1.12.4 as builder

LABEL maintainer="[email protected]"

Expand Down
4 changes: 0 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ test unit test
generate generate code using gommon
loc lines of code (cloc required, brew install cloc)

Dev first time:
dep-install install dependencies based on lock file
dep-update update dependency based on spec and code

Build:
install install all binaries under ./cmd to $$GOPATH/bin
build compile all binary to ./build for current platform
Expand Down
37 changes: 8 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,42 +17,21 @@

Gommon is a collection of common util libraries written in Go.

It has the following components:

- [errors](errors) error wrapping, inspection, multi error (error list), common error types
- [log](log) fine grained level control and reasonable performance
- [log](log) per package logger with [reasonable performance](log/_benchmarks/README.md)
- [noodle](noodle) embed static assets for web application with `.noodleignore` support
- [generator](generator) render go template, generate methods for logger interface based on `gommon.yml`
- [structure](structure) data structure like Set etc. to go
- [util](util) small utils over standard libraries utils

Legacy

- [config v1](config) A YAML config reader with template support
- [log v1](legacy/log) A logrus like structured logger
- [runner](legacy/runner) A os/exec wrapper
- [requests](requests) A pythonic wrapper for `net/http`, HTTP for Gopher

## Dependencies

Currently we only have one non standard library dependencies (cmd and examples are not considered), see [Gopkg.lock](Gopkg.lock)

- [go-yaml/yaml](https://github.com/go-yaml/yaml) for read config written in YAML
- we don't need most feature of YAML, and want to have access to the parser directly to report which line has incorrect semantic (after checking it in application).
- might write one in [ANTLR](https://github.com/antlr/antlr4)
- we also have a DSL work in progress [RCL: Reika Configuration Language](https://github.com/at15/reika/issues/49), which is like [HCL](https://github.com/hashicorp/hcl2)

Removed
- [util](util) wrappers for standard libraries

- [pkg/errors](https://github.com/pkg/errors) for including context in error, removed in [#59](https://github.com/dyweb/gommon/pull/59)
replaced by `gommon/errors`
It has little third party dependencies, only [go-yaml/yaml](https://github.com/go-yaml/yaml) in [util/cast](util/cast),
[go-shellquote](github.com/kballard/go-shellquote) in [generator](generator),
other dependencies like cobra are only for cli, see [go.mod](go.mod).

## Development

- install go https://golang.org/
- install dep https://github.com/golang/dep
- `make dep-install`
- `make test`
- requires go1.12+. go1.11.x should work as well, the Makefile set `GO111MODULE=on` so you can use in GOPATH
- `make help`
- [Directory layout](directory.md)

## License

Expand Down
1 change: 0 additions & 1 deletion directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
- [doc](doc) style guide and developer log
- [errors](errors) error wrapping, multi error and error inspection
- [generator](generator) generating interface methods, render go template, execute shell command.
- [legacy](legacy) legacy code base
- [noodle](noodle) embed static assets for go binary with .ignore file support
- [playground](playground) test library and replay issues
- [scripts](scripts) test scripts
Expand Down

0 comments on commit d6c4339

Please sign in to comment.