From 026ff5cb12b78de4f75c5e55081e95458425a7ba Mon Sep 17 00:00:00 2001 From: Daniel Oaks Date: Wed, 11 Apr 2018 14:46:54 +1000 Subject: [PATCH] readme: Update a lil more --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6c8c956b..cfc61965 100644 --- a/README.md +++ b/README.md @@ -67,18 +67,20 @@ The `stable` branch contains the latest release. You can run this for a producti #### Building -[![Build Status](https://travis-ci.org/oragono/oragono.svg?branch=master)](https://travis-ci.org/oragono/oragono) +Clone the appropriate branch. You should also run this command to set up vendored dependencies: +``` +git submodule update --init +``` -Clone the appropriate branch. You should also run `git submodule update --init` to set up vendored dependencies. - -From the root folder, run `make` to generate all release files in `/dist` for all of our target OSes: +From the root folder, you can run `make`, using [GoReleaser](https://goreleaser.com/) to generate all of our release binaries in `/dist`: ``` make ``` -Otherwise, if you'd like to manually build a very specific executable, you can run the typical `go build oragono.go` command. - -However, when just developing I usually execute `go run oragono.go`. That rebuilds Oragono on the fly with the latest changes. +However, when just developing I instead just use this command to rebuild and run Oragono on the fly with the latest changes: +``` +go run oragono.go +``` ## Configuration