From 2ebfb6ce6992459b5ce16e17ed4934c9d89f1702 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Fri, 4 Sep 2020 16:38:32 +0100 Subject: [PATCH] README: clarify deprecation and point to modules See https://github.com/golang/go/issues/38158. --- README.md | 11 +++-------- docs/introduction.md | 4 ++++ 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b350cfc2be..2db8401528 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,13 @@

-Would you like to see your company name here? We're looking for a stable source of -funding. - ## Dep `dep` is a dependency management tool for Go. It requires Go 1.9 or newer to compile. -`dep` was initially developed to experiment with a new dependency management system -for Go; but, as of Go 1.11, **the Go project has officially adopted a different approach, -based on the concept of Modules**, which is described in a [series of posts](https://blog.golang.org/using-go-modules) -published on [blog.golang.org](https://blog.golang.org). +Please note that Dep was an official experiment to implement a package manager +for Go. As of 2020, Dep is deprecated and archived in favor of Go modules, which +have had official support since Go 1.11. For more details, see https://golang.org/ref/mod. For guides and reference materials about `dep`, see [the documentation](https://golang.github.io/dep). diff --git a/docs/introduction.md b/docs/introduction.md index 326de20ff1..a2003399a3 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -3,6 +3,10 @@ id: introduction title: Getting Started --- +Please note that Dep was an official experiment to implement a package manager +for Go. As of 2020, Dep is deprecated and archived in favor of Go modules, which +have had official support since Go 1.11. For more details, see https://golang.org/ref/mod. + Welcome! This is documentation for dep, the "official experiment" dependency management tool for the Go language. Dep is a tool intended primarily for use by developers, to support the work of actually writing and shipping code. It is _not_ intended for end users who are installing Go software - that's what `go get` does. This site has both guides and reference documents. The guides are practical explanations of how to actually do things with dep, whereas the reference material provides deeper dives on specific topics. Of particular note is the [glossary](glossary.md) - if you're unfamiliar with terminology used in this documentation, make sure to check there!