From 8a75e93576ea9875f386a3ebfced54d1b560f237 Mon Sep 17 00:00:00 2001 From: Philip O'Toole Date: Sat, 21 Dec 2019 09:16:02 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0fa6c94..a2230d75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ Please avoid using libaries other than those available in the standard library, ## Building rqlite *Building rqlite requires Go 1.12 or later. [gvm](https://github.com/moovweb/gvm) is a great tool for installing and managing your versions of Go.* -Download, build, and run rqlite like so (tested on 64-bit Kubuntu 14.04 and OSX): +A key design goal of rqlite is to keep the build process as simple as possible. Download, build, and run rqlite like so (tested on 64-bit Kubuntu 16.04 and OSX): ```bash mkdir rqlite # Or any directory of your choice. @@ -26,7 +26,7 @@ $GOPATH/bin/rqlited ~/node.1 ``` This starts a rqlite server listening on localhost, port 4001. This single node automatically becomes the leader. -To rebuild, perhaps after making some changes to the source, do something like the following: +To rebuild and run, perhaps after making some changes to the source, do something like the following: ```bash cd $GOPATH/src/github.com/rqlite/rqlite go install ./... @@ -37,7 +37,7 @@ $GOPATH/bin/rqlited ~/node.1 The process outlined above will work for Linux, OSX, and Windows. For Raspberry Pi, check out [this issue](https://github.com/rqlite/rqlite/issues/340). ### Speeding up the build process -It can be rather slow to rebuild rqlite, due to the repeated compilation of SQLite support. You can compile and install this library once, so subsequent builds are much faster. To do so, execute the following commands: +It can be rather slow to rebuild rqlite, due to the repeated compilation of the SQLite source code. You can compile and install the SQLite libary once, so subsequent builds are much faster. To do so, execute the following commands: ```bash cd $GOPATH go install github.com/mattn/go-sqlite3