diff --git a/README.md b/README.md index 5f3a7ff..d4d2cd9 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,34 @@ CSS Preprocessor: __[SASS](http://sass-lang.com/)__ CSS Toolkit: __[Bootstrap 4](http://getbootstrap.com/)__ Package Manager: __[npm](https://www.npmjs.com/)__ -## Deployment +## Contribution Set-up & Deployment ```shell -# Clone the Repo -git clone https://github.com/Ennovar/gPanel.git +# Go get the repo and append it to your $GOPATH +go get https://github.com/Ennovar/gPanel.git -# Navigate to the directory -cd gPanel - -# Start the web-hosting server -go run main.go +# Navigate to the directory (replace $GOPATH with your actual $GOPATH) +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 + +# OPTIONAL: Change the names of the remotes +git remote rename origin upstream +git remote rename fork origin +``` + +To deploy... + +```shell +# Starting gPanel +go run main.go + +# OPTIONAL: Create binary to run +go build main.go +./main ``` diff --git a/main.go b/main.go index d98ecee..ef83cf0 100644 --- a/main.go +++ b/main.go @@ -1,10 +1,11 @@ package main import ( - "gPanel/private_server/routing" - "gPanel/public_server/routing" "log" "net/http" + + "github.com/Ennovar/gPanel/private_server/routing" + "github.com/Ennovar/gPanel/public_server/routing" ) func main() { diff --git a/private_server/logging/logging.go b/private_server/logging/logging.go index 9ef24d6..c9a7c2b 100644 --- a/private_server/logging/logging.go +++ b/private_server/logging/logging.go @@ -1,10 +1,11 @@ package privateLogging import ( - "gPanel/general/networking" "log" "os" "strings" + + "github.com/Ennovar/gPanel/general/networking" ) const ( diff --git a/private_server/routing/routing.go b/private_server/routing/routing.go index 71b2978..c7c696f 100644 --- a/private_server/routing/routing.go +++ b/private_server/routing/routing.go @@ -2,10 +2,11 @@ package privateRouting import ( "bufio" - "gPanel/private_server/logging" "net/http" "os" "strings" + + "github.com/Ennovar/gPanel/private_server/logging" ) type privateHost struct { diff --git a/public_server/logging/logging.go b/public_server/logging/logging.go index 5a8f194..1c9f73d 100644 --- a/public_server/logging/logging.go +++ b/public_server/logging/logging.go @@ -1,10 +1,11 @@ package publicLogging import ( - "gPanel/general/networking" "log" "os" "strings" + + "github.com/Ennovar/gPanel/general/networking" ) const ( diff --git a/public_server/routing/routing.go b/public_server/routing/routing.go index 4bb7b3f..c72c61c 100644 --- a/public_server/routing/routing.go +++ b/public_server/routing/routing.go @@ -2,10 +2,11 @@ package publicRouting import ( "bufio" - "gPanel/public_server/logging" "net/http" "os" "strings" + + "github.com/Ennovar/gPanel/public_server/logging" ) type publicWeb struct {