diff --git a/README.md b/README.md index 2f0c20fc..c77f322e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ [![Go Reference](https://pkg.go.dev/badge/golang.org/x/text.svg)](https://pkg.go.dev/golang.org/x/text) -This repository holds supplementary Go libraries for text processing, many involving Unicode. +This repository holds supplementary Go packages for text processing, +many involving Unicode. ## CLDR Versioning @@ -11,13 +12,11 @@ by your Go compiler. The `x/text` repository supports multiple versions of Unicode and will match the version of Unicode to that of the Go compiler. At the moment this is supported for Go compilers from version 1.7. -## 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`. +To submit changes to this repository, see http://go.dev/doc/contribute. -## Contribute -To submit changes to this repository, see http://golang.org/doc/contribute.html. +The git repository is https://go.googlesource.com/text. 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 @@ -29,6 +28,7 @@ directory, which holds all files that are used as a source for generating the tables. This directory will also serve as a cache. ## Testing + Run go test ./... @@ -52,6 +52,7 @@ 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 UNICODE_VERSION=x.x.x go generate @@ -73,11 +74,8 @@ 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. +## Report Issues -The main issue tracker for the image repository is located at -https://github.com/golang/go/issues. Prefix your issue with "x/text:" in the +The main issue tracker for the text repository is located at +https://go.dev/issues. Prefix your issue with "x/text:" in the subject line, so it is easy to find.