Skip to content

v1.0.0 Setup initial project

Mihai Claudiu Toader edited this page Mar 2, 2017 · 12 revisions

This page describes how a project should be setup using v1.0.0 release (or custom build from branch) in order to get all the functionality working properly.

For now*, the plugin uses the following convention:

  • Go SDK -> the place where you have installed your Go distribution
  • Go Libraries -> GOPATH(s)

* Note: This might be subject to change in the future releases.

TOC

Create a new Project

Common

To create a new project and configure it properly you need to perform the following operations:

  • download the latest release from the plugin manager of your IDE
  • after the plugin is installed, restart the IDE

If you want to have access to newer releases that include the latest and greatest features, you can also choose to install the plugin from either the nightly or the alpha repositories. To do so, please follow the instructions in the README file.

Now, please follow the steps according to your IDE:

IntelliJ IDEA

  • create a new project by going to Create New Project | Go and follow the setup steps.

Other IDEs

  • create a new blank project and you'll be prompted to setup a GO SDK for it

Once you've created the project according to your IDE, please follow the steps below:

  • after your project has been created, you can then add your GOPATH packages to it so that you can use all the plugin features
  • to do, go to File | Settings | Languages & Frameworks | Go Libraries. Here you have a few options to choose from, but the recommended (and most tested one at the moment) is to create a new entry under Global Libraries that points to your GOPATH directory (see the example bellow).
  • if you've followed the steps correctly, then "everything" should work for you

One concrete example would be (under Linux, paths may vary on other OSes):

  • GOROOT (aka sdk home) /usr/local/go
  • GOPATH (the path in Go Libraries | Global Libraries) /home/florin/golang/
  • project home /home/florin/golang/src/github.com/dlsniper/misc

Reporting issues

Unfortunately, from time to time bugs sneak in without our knowledge. We highly appreciate your help in tracking down new ones but please make sure to check our issue tracker for the existing ones before opening a new issue.

Contributing

We gladly accept contributions, be it in form of well explained and repeatable tests scenarios, code snippets that can reproduce the issue you are having or PRs to fix things or add missing functionality.

See our contributing documentation to get you started.