Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Commit 768d5d1

Browse files
committed
README: clarify deprecation and point to modules
See golang/go#38158.
1 parent 87f3094 commit 768d5d1

File tree

2 files changed

+7
-24
lines changed

2 files changed

+7
-24
lines changed

README.md

+3-24
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,13 @@
55
<a href="https://goreportcard.com/report/github.com/golang/dep"><img src="https://goreportcard.com/badge/github.com/golang/dep" /></a>
66
</p>
77

8-
<i>Would you like to see your company name here? <a
9-
href="https://github.com/golang/dep/issues/2165">We're looking for a stable source of
10-
funding.</a></i>
11-
128
## Dep
139

1410
`dep` is a dependency management tool for Go. It requires Go 1.9 or newer to compile.
1511

16-
`dep` was initially developed to experiment with a new dependency management system
17-
for Go; but, as of Go 1.11, **the Go project has officially adopted a different approach,
18-
based on the concept of Modules**, which is described in a [series of posts](https://blog.golang.org/using-go-modules)
19-
published on [blog.golang.org](https://blog.golang.org).
12+
** NOTE: ** Dep was an official experiment to implement a package manager for
13+
Go. As of 2020, Dep is deprecated and archived in favor of Go modules, which
14+
have had official support since Go 1.11. For more details, see https://golang.org/ref/mod.
2015

2116
For guides and reference materials about `dep`, see [the documentation](https://golang.github.io/dep).
2217

@@ -58,19 +53,3 @@ install via `go get`:
5853
```sh
5954
go get -u github.com/golang/dep/cmd/dep
6055
```
61-
62-
## Feedback
63-
64-
Feedback is greatly appreciated.
65-
At this stage, the maintainers are most interested in feedback centered on the user experience (UX) of the tool.
66-
Do you have workflows that the tool supports well, or doesn't support at all?
67-
Do any of the commands have surprising effects, output, or results?
68-
Let us know by filing an issue, describing what you did or wanted to do, what you expected to happen, and what actually happened.
69-
70-
## Contributing
71-
72-
Contributions are greatly appreciated.
73-
The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
74-
The project follows the typical GitHub pull request model.
75-
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
76-
Before starting any work, please either comment on an existing issue, or file a new one.

docs/introduction.md

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: introduction
33
title: Getting Started
44
---
55

6+
** NOTE: ** Dep was an official experiment to implement a package manager for
7+
Go. As of 2020, Dep is deprecated and archived in favor of Go modules, which
8+
have had official support since Go 1.11. For more details, see https://golang.org/ref/mod.
9+
610
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.
711

812
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!

0 commit comments

Comments
 (0)