diff options
Diffstat (limited to 'vendor/golang.org/x/text/README.md')
| -rw-r--r-- | vendor/golang.org/x/text/README.md | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/vendor/golang.org/x/text/README.md b/vendor/golang.org/x/text/README.md index 24be1c676..75e29bcd7 100644 --- a/vendor/golang.org/x/text/README.md +++ b/vendor/golang.org/x/text/README.md @@ -1,7 +1,8 @@ -This repository holds supplementary Go libraries for text processing, many involving Unicode. +# Go Text +This repository holds supplementary Go libraries for text processing, many involving Unicode. -# Semantic Versioning +## Semantic Versioning This repo uses Semantic versioning (http://semver.org/), so 1. MAJOR version when you make incompatible API changes, 1. MINOR version when you add functionality in a backwards-compatible manner, @@ -18,8 +19,12 @@ So going from 0.1.0 to 0.2.0 is considered to be a major version bump. A major new CLDR version is mapped to a minor version increase in x/text. Any other new CLDR version is mapped to a patch version increase in x/text. +## Download/Install -# Contribute +The easiest way to install is to run `go get -u golang.org/x/text`. You can +also manually git clone the repository to `$GOPATH/src/golang.org/x/text`. + +## Contribute To submit changes to this repository, see http://golang.org/doc/contribute.html. To generate the tables in this repository (except for the encoding tables), @@ -40,6 +45,20 @@ from this directory to run all tests. Add the "-tags icu" flag to also run ICU conformance tests (if available). This requires that you have the correct ICU version installed on your system. +TODO: +- updating unversioned source files. + +## Generating Tables + +To generate the tables in this repository (except for the encoding +tables), run `go generate` from this directory. By default tables are +generated for the Unicode version in core and the CLDR version defined in +golang.org/x/text/unicode/cldr. + +Running go generate will as a side effect create a DATA subdirectory in this +directory which holds all files that are used as a source for generating the +tables. This directory will also serve as a cache. + ## Versions To update a Unicode version run @@ -61,3 +80,12 @@ backwards compatibility is not maintained. So updating to a different version may not work. The files in DATA/{iana|icu|w3|whatwg} are currently not versioned. + +## Report Issues / Send Patches + +This repository uses Gerrit for code changes. To learn how to submit changes to +this repository, see https://golang.org/doc/contribute.html. + +The main issue tracker for the image repository is located at +https://github.com/golang/go/issues. Prefix your issue with "x/image:" in the +subject line, so it is easy to find. |