Added a Makefile for simplicity.

sourcegraph · Oct 16, 2018 · fe4e608 · sqs · Oct 16, 2018 · sqs
1 parent d91851a
commit fe4e608
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 /out/
+.idea
+.DS_Store
diff --git a/Makefile b/Makefile
@@ -0,0 +1,10 @@
+DOCS=../sourcegraph/doc
+
+install-docsite:
+	GO111MODULE=on go get github.com/sourcegraph/docsite/cmd/docsite
+
+server:
+	docsite -assets assets -sources $(DOCS) -templates templates serve
+
+check:
+	docsite -assets assets -sources $(DOCS) -templates templates check -skip-urls '(^#|^https?://)'
diff --git a/README.md b/README.md
@@ -1,25 +1,29 @@
-# docs.sourcegraph.com
+# Sourcegraph Docs
 
 The templates and assets for [docs.sourcegraph.com](https://docs.sourcegraph.com). The actual documentation content lives in [sourcegraph/sourcegraph@`docs`](https://github.com/sourcegraph/sourcegraph/tree/docs/doc) (will be merged to `master` soon).
 
+## Requirements
+
+- Golang 1.11
+
 ## Usage
 
-Install `docsite`:
+This uses [docsite](https://github.com/sourcegraph/docsite) which you can install by running:
 
 ```shell
-go get github.com/sourcegraph/docsite/cmd/docsite
+make install-docsite
 ```
 
 The following commands assume that you are in this repository's top-level directory and that [sourcegraph/sourcegraph@`docs`](https://github.com/sourcegraph/sourcegraph/tree/docs) is checked out at `../sourcegraph`.
 
 To run an HTTP server for this site:
 
 ```shell
-docsite -assets assets -sources ../sourcegraph/doc -templates templates serve
+make server
 ```
 
 To check for common problems in the Markdown and template files:
 
 ```shell
-docsite -assets assets -sources ../sourcegraph/doc -templates templates check -skip-urls '(^#|^https?://)'
+make check
 ```