yagocarballo / go-gl-assignment-2

OpenGL assignment built with Go

Build the Project

Mac & Linux

Requeriments

• Go
• Git
• GCC

How to Install

To get the App

$ go get github.com/yagocarballo/Go-GL-Assignment-2 ## this generates the binary in the bin directory

Compile or Run the App

## To run the app
go run $GOPATH/src/github.com/yagocarballo/Go-GL-Assignment-2/basic.go

## To Compile the App (The generated binary will run without the need of having installed go, gcc or git)
$ go get github.com/yagocarballo/Go-GL-Assignment-2 ## this generates the `binary` in the `bin` directory

## or
$ go build -o dist/basic $GOPATH/src/github.com/yagocarballo/Go-GL-Assignment-2/basic.go

## the last command generates the binary file in the `dist` folder

Important: To open the Binary, you need to be in the root of the project (or have the resources folder in the same folder)

• If the resources folder is not in the same path the program will break when running.

## from the project's root run, to open the app
$ bin/Go-GL-Assignment-2 

If the terminal is closed next time is opened the GOPATH variable needs to be set again with export GOPATH=pwd/go_modules

Windows

Requirements

• GCC is required to compile the OpenGL biddings and the GLFW Wrapper.
• Git is required to fetch the dependencies.
• Go is required to fetch dependencies and compile.

How to compile

Step 1

• Install Go from https://golang.org/dl/
• Add the folder C:\Go\bin to the PATH (If not added by the installer)

Step 2

• Install Git from https://git-scm.com/download/win
• Add Git to the PATH

Step 3

Install TDM-GCC from http://tdm-gcc.tdragon.net/ (Choose the x64 and x86 version, for the rest use the default settings)

TDM-GCC is the recommended GCC compiler for Go in windows (is the only one that is officially supported by the Go Team)

Step 4

• Clone the project's repo (if already cloned skip to step 4)

Step 5

• Open the MinGW terminal installed by TDM-GCC (or open the windows CMD and run the C:\TDM-GCC-64\mingwvars.bat script to add the GCC to the path in that session)
• Check that the go command exists by doing go version
• Check that the git command exists by doing git --version
• Check that the gcc command exists by doing gcc -v
• If both commands work, continue to the step 5

Step 6

• Go to to the path where the project is located with cd c:/<path-to-project>

Step 7

• Set the GOPATH variable to be the same as the project

set GOPATH=<path-to-the-project>

Step 8

• Fetch the dependencies:

## Gets the OpenGL Versions Used by this project
go get github.com/yagocarballo/Go-GL-Assignment-2

## this generates the `.exe` in the `bin` directory

• If all the above steps worked without errors continue to step 9

Step 9

• All the dependencies are now downloaded, and the project has been compiled.

## To run the app
./bin/Go-GL-Assignment-2.exe

## or
go run $GOPATH/src/github.com/yagocarballo/Go-GL-Assignment-2/basic.go

## To Compile the App (The generated .exe will run without the need of having installed go, gcc or git)
go get github.com/yagocarballo/Go-GL-Assignment-2 ## this generates the `.exe` in the `bin` directory

## or
go build -o dist/basic.exe $GOPATH/src/github.com/yagocarballo/Go-GL-Assignment-2/basic.go

## the last command generates the `.exe` file in the `dist` folder

Important: To open the Binary, you need to be in the root of the project (or have the resources folder in the same folder)

• If the resources folder is not in the same path the program will break when running.

## Copy the shaders folder to dist (select `D` when asked)
xcopy shaders "bin/resources" 

## Move to the `bin` folder
cd bin

## Run the App
Go-GL-Assignment-2.exe

If the terminal is closed next time is opened the GOPATH variable needs to be set again with set GOPATH=<path-to-the-project>