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

Commit 5e064a5

Browse files
committed
docs: Add installation.md, lots of tweaks
Assorted edits and wording tweaks, as well as including bash as type on most of the fenced code blocks. Also relocated assets into docs/assets from docs/img in order to accommodate docusaurus' expected layout.
1 parent 7ae1fda commit 5e064a5

33 files changed

+97
-86
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="docs/img/DigbyShadows.png" width="360"></p>
1+
<p align="center"><img src="docs/assets/DigbyShadows.png" width="360"></p>
22
<p align="center">
33
<a href="https://travis-ci.org/golang/dep"><img src="https://travis-ci.org/golang/dep.svg?branch=master" alt="Build Status"></img></a>
44
<a href="https://ci.appveyor.com/project/golang/dep"><img src="https://ci.appveyor.com/api/projects/status/github/golang/dep?svg=true&branch=master&passingText=Windows%20-%20OK&failingText=Windows%20-%20failed&pendingText=Windows%20-%20pending" alt="Windows Build Status"></a>
@@ -15,9 +15,9 @@ For guides and reference materials about `dep`, see [the documentation](https://
1515

1616
## Installation
1717

18-
Unless you are hacking on dep, it is strongly recommended that you use a released version. You can grab the latest binary from the [releases](https://github.com/golang/dep/releases) page.
18+
It is strongly recommended that you use a released version. Release binaries are available on the [releases](https://github.com/golang/dep/releases) page.
1919

20-
On macOS you can install or upgrade to the latest released version with Homebrew:
20+
On MacOS you can install or upgrade to the latest released version with Homebrew:
2121

2222
```sh
2323
$ brew install dep

docs/FAQ.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,8 @@
11
---
2-
id: faq.md
3-
---
4-
5-
6-
72
title: FAQ
8-
--
9-
10-
# FAQ
11-
12-
_The first rule of FAQ is don't bikeshed the FAQ, leave that for
13-
[Create structure for managing docs](https://github.com/golang/dep/issues/331)._
3+
---
144

15-
Please contribute to the FAQ! Found an explanation in an issue or pull request helpful?
16-
Summarize the question and quote the reply, linking back to the original comment.
5+
The FAQ predated the introduction of the rest of the documentation. If something in here conflicts with other guides or reference documents, it's probably here that it's wrong - please file a PR!
176

187
## Concepts
198
* [Does `dep` replace `go get`?](#does-dep-replace-go-get)

docs/Gopkg.lock.md

Lines changed: 8 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)