archives/tweego
2
0
Fork 0
mirror of https://github.com/tmedwards/tweego.git synced 2025-07-04 21:50:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Devel] Update README.

Browse source
This commit is contained in:
Thomas M. Edwards 2019-12-25 11:42:46 -06:00
parent 4f1b08abca
commit 78cc697889
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -8,7 +8,7 @@ If you believe that you've found a bug in Tweego or simply wish to make a sugges
## INSTALLATION ## INSTALLATION
You may either download one of the precompiled binaries from [Tweego's website](http://www.motoslave.net/tweego/), which are available in both 32- and 64-bit versions for multiple operating systems, or build Tweego from source (see **BUILDING FROM SOURCE** below). You may either download one of the precompiled binaries from [Tweego's website](http://www.motoslave.net/tweego/), which are available in both 32- and 64-bit versions for multiple operating systems, or build Tweego from source—see **BUILDING FROM SOURCE** below.
## BUILDING FROM SOURCE ## BUILDING FROM SOURCE
@ -16,8 +16,8 @@ If you want to build Tweego from scratch, rather than grabbing one of the precom
Tweego is written in the Go programming language, so you'll need to install it, if you don't already have it. Additionally, to retrieve Go packages—like Tweego and its dependencies—from source control repositories, you'll need to install Git. Tweego is written in the Go programming language, so you'll need to install it, if you don't already have it. Additionally, to retrieve Go packages—like Tweego and its dependencies—from source control repositories, you'll need to install Git.
1. [Download and install the Go programming language (want ≥v1.13)](http://golang.org/doc/install) 1. [Download and install the Go programming language (`https://golang.org/`)](https://golang.org/) ← Get version ≥v1.13
2. [Download and install the Git source control management tool](https://git-scm.com/) 2. [Download and install the Git source control management tool (`https://git-scm.com/`)](https://git-scm.com/)
Once all the tooling is installed and set up, the next step is to fetch the Tweego source code. Open a shell to wherever you wish to store the code and run the following command to clone the repository: Once all the tooling is installed and set up, the next step is to fetch the Tweego source code. Open a shell to wherever you wish to store the code and run the following command to clone the repository:
@ -31,13 +31,20 @@ Next, change to the directory that the previous command created:
cd tweego cd tweego
``` ```
Next, fetch Tweego's dependencies: There are two major branches within the repository:
* `master`: The stable release branch
* `develop`: The main development branch
Be sure to switch to the branch you wish to work on by issuing the appropriate `git checkout` command.
Once you're on the correct branch, fetch Tweego's dependencies:
``` ```
go get go get
``` ```
You should now have Tweego and all its dependencies downloaded, so you may now compile and install it to your `GOPATH` by running the following command: You should now have Tweego and all its dependencies downloaded, so you may compile and install it to your `GOPATH` by running the following command:
``` ```
go install go install