updated the readme

This commit is contained in:
superwhiskers 2018-03-27 14:02:14 -05:00
parent 38bbebf790
commit 2a7efd62de
2 changed files with 20 additions and 17 deletions

View file

@ -1,13 +1,14 @@
# maryo
## a proxy server used for accessing Pretendo, the open source Nintendo Network replacement
## a proxy server used for accessing pretendo, the open source nintendo network replacement
## *(also known as the terminal app your grandma can use)*
## about
maryo is a proxy program intended to be as easy as possible to use, the user interface comes first, then the features. if i were to focus more on the features, i could end up with a program that works, but i'd then have a bunch of people asking me how to use it.
## instructions
### using precompiled binaries:
go to the releases, and download the
correct binary for your system. just double-click
it and follow the instructions
### using precompiled binaries
go to the releases, and download the correct binary for your system. just double-click it and follow the instructions (*it's that easy!*)
### building from source ~~(WARNING: EXTREMELY HARDCORE)~~
#### prerequisites
@ -15,8 +16,10 @@ it and follow the instructions
- [goproxy](https://github.com/elazarl/goproxy)
- [ansicolor](https://github.com/shiena/ansicolor)
- [httpscerts](https://github.com/kabukky/httpscerts)
- [go-asyncserver (not required yet, but may be soon)](https://github.com/hectane/go-asyncserver)
#### building
1. clone this repository
2. it's easy, just `go build` in the source directory
3. you can then double click your own binaries instead of ours (i don't care)

View file

@ -49,7 +49,7 @@ func main() {
os.Exit(0)
}
// if not forced to do setup
if *doSetup == false {
@ -60,10 +60,10 @@ func main() {
fileMap := make(map[string]string)
// config.json -- if nonexistent, it follows the user's instruction to create one, or use a builtin copy
// set it to nonexistent beforehand
fileMap["config"] = "ne"
// check if config exists
if doesFileExist(*config) != false {
@ -72,15 +72,15 @@ func main() {
// set fileMap to have the correct status for the file
fileMap["config"] = "iv"
// if it isn't
// if it isn't
} else {
// "ditto"
fileMap["config"] = "va"
}
}
// cert.pem and key.pem -- if nonexistent, just do setup
@ -104,8 +104,8 @@ func main() {
// perform setup
setup(fileMap)
// if it's invalid
// if it's invalid
} else if fileMap["config"] == "iv" {
// i'm not just going to perform autosetup because they might have some stuff in there
@ -115,7 +115,7 @@ func main() {
fmt.Printf(" 2. delete the config and run this program\n")
fmt.Printf(" 3. fix the config\n")
os.Exit(1)
// if the certificates don't exist
} else if fileMap["cert"] == "ne" {
@ -127,14 +127,14 @@ func main() {
fmt.Printf(" 3. provide your own certs\n")
os.Exit(1)
// otherwise, start the proxy
// otherwise, start the proxy
} else {
// start the proxy
startProxy(*config, *logging)
}
// run setup function
} else {
@ -149,5 +149,5 @@ func main() {
setup(fileMap)
}
}