updating readme

This commit is contained in:
George Shaw 2017-11-27 17:05:29 -06:00
parent 8a25a5a119
commit adf8f005a0

View file

@ -4,7 +4,6 @@ A web-hosting control panel written in Go.
## Stack
Version Control: __[git](https://git-scm.com/)__
Backend: __[Go](https://golang.org/)__
Database: __[Bolt](https://github.com/boltdb/bolt)__
CSS Toolkit(s): __[Bootstrap 4](http://getbootstrap.com/) & [Font Awesome](http://fontawesome.io/)__
@ -12,6 +11,8 @@ JS Toolkit(s): __[jQuery](https://jquery.com/)__
## Contribution Set-up & Deployment
To get the repo...
```shell
# Go get the repo and append it to your $GOPATH
go get github.com/Ennovar/gPanel
@ -23,8 +24,8 @@ cd $GOPATH/github.com/Ennovar/gPanel
To set your repo up to contribute...
```shell
# Fork the repo and add it to the list of remotes
git remote add fork https://github.com/Ennovar/gPanel.git
# Fork the repo and add it to the list of remotes (replace your-username with your github username)
git remote add fork https://github.com/your-username/gPanel.git
# OPTIONAL: Change the names of the remotes
git remote rename origin upstream
@ -36,8 +37,4 @@ To deploy...
```shell
# Starting gPanel
go run main.go
# OPTIONAL: Create binary to run
go build main.go
./main
```