mollusk/project-rpg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add sections for git, local project setup, Refine VSCode section

Browse Source
This commit is contained in:
mollusk 2018-01-16 01:59:07 -07:00
parent fb4c3bb519
commit 610a59894b
1 changed files with 41 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
DEVELOPERS.md
View File

@ -28,7 +28,42 @@ This should provide the following output:
go version go1.9.2 linux/amd64
```
Now you can move on to getting Visual Studio Code.
Now you can move on to the next step
# Installing and setting up Git
We wouldn't get very far without installing and setting up Git. Version control of our code is vital to keeping track of changes. Here is a quick guide on how to get up and running with Git.
## Ubuntu 16.04
In a terminal window, wnter the following command:
```
sudo apt update && sudo apt install git
```
Next we need to set up user information so that you can create commits:
```
git config --global user.name "Your desired commit name"
git config --global user.email "yourName@mail.com"
```
Now you can make commits on your changes and have them tied to your name and email (this is required to commit with Git)
We can now move on....
# Get a Copy of This Project
In order to work on this project, you will need a local copy of it. This can be done using git directly, but GO offers the ability to "go get" the project for us. This will be placed in ```/home/$USER/go/src``` along with the proper domain it was pulled from (i.e gitbutter.pw), the owner (i.e Zolfite) and the name of the project.
The full path looks like: ```/home/$USER/go/src/gitbutter.pw/zolfite/project-rpg```
The command to do all of this is as follows:
```
go get gitbutter.pw/zolfite/project-rpg
```
Next we go over setting up Visual studio code. You can use VSCode to open our project folder ```project-rpg``` specified in the path above.
# Install and Setup Visual Studio Code
@ -89,9 +124,12 @@ This will refresh VSCode and enable any newly installed extensions.
Once the GO Extension is installed, all you have to do now is open an existing .go file and follow the prompt.
Once you open a .go file, a message will appear at the top of the VSCode Window.
* Click the ```File``` menu and select ```Open Folder```
* Navigate to ```/home/YourName/go/src/gitbutter.pw/zolfite/project-rpg```
* Click open to open the folder
It will ask if you want to install the first required tool of the GO extension or to install all.
VSCode will ask if you want to install the first required tool of the GO extension OR to install all.
Make sure you choose "Install all"