From 8a0e65e7b4f02a20d3127cd6960cdf11941d2ad4 Mon Sep 17 00:00:00 2001 From: Ian Lance Taylor Date: Thu, 31 Oct 2024 15:46:39 -0700 Subject: [PATCH] README: don't recommend go get These days people will just import the packages and the go tool will do the right thing. We don't need to explain it. Add a pointer to the git repo, though. For golang/go#62645 Change-Id: I0a1721eb456645c1422580497e3dcc9906a41223 Reviewed-on: https://go-review.googlesource.com/c/text/+/624296 Auto-Submit: Ian Lance Taylor Reviewed-by: Ian Lance Taylor Commit-Queue: Ian Lance Taylor LUCI-TryBot-Result: Go LUCI Reviewed-by: Dmitri Shuralyov Reviewed-by: Dmitri Shuralyov --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) 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.