added a lovely man page

Simply build it with "npm run man"

4 files changed, 153 insertions, 1 deletions

diff --git a/docs/viper.1 b/docs/viper.1
new file mode 100644
index 0000000..0b399b8
--- /dev/null
+++ b/docs/viper.1
@@ -0,0 +1,58 @@
+.TH "VIPER" "1" "December 2021" "" ""
+.SH "NAME"
+\fBviper\fR \- update and manage northstar
+.SH SYNOPSIS
+.P
+\fBviper\fP [<optional>\|\.\.\.]
+.SH DESCRIPTION
+.P
+Viper is a program made to make updating and launching Northstar a lot easier\. It has both a CLI and GUI tool, specifying no command line arguments opens the latter\.
+.SH OPTIONS
+.P
+\fB\-\-help\fP
+   Shows a brief message of all the options and what they do\.
+.P
+\fB\-\-version\fP
+   Various versions numbers for Node, Electron, Viper and so on\.
+.P
+\fB\-\-cli\fP
+   Forces the CLI to activate, meaning the GUI will never run\. 
+   What purpose this has I frankly do not know\.
+.P
+\fB\-\-update\fP
+   Updates Northstar, this uses your \fBviper\.json\fP to determine the location, it also won't try to update if the installed version of Northstar is already the newest, if you must re\-install Northstar you can delete the \fBns_version\.txt\fP file in the game path\.
+.P
+\fB\-\-launch\fP=<version>
+   Launches Northstar, this is currently only supported on Windows\.
+   If you must launch Vanilla you can run \fB\-\-launch=vanilla\fP
+.P
+\fB\-\-setpath\fP=<absolute\-path>
+   Sets the game path, this'll change the \fBgamepath\fP variable in your \fBviper\.json\fP, note that it only takes in absolute paths and not relative ones\.
+.SH CONFIGURATION
+.P
+All configuration takes place in your \fBviper\.json\fP file, this file may be in various locations depending on your platform, for Linux you're likely to find it at:
+.RS 0
+.IP \(bu 2
+\fB$XDG_CONFIG_HOME/viper\.json\fP
+.IP \(bu 2
+\fB~/\.config/viper\.json\fP
+
+.RE
+.P
+On Windows it's likely to be in \fB%APPDATA%\\viper\.json\fP
+.P
+All configuration is done by Viper itself, the locale is auto set when the GUI launches through your systems locale, the gamepath is selected with \fB\-\-setpath\fP or in the GUI\.
+.SH BUGS
+.P
+Report bugs on the GitHub issues page, and feel free to make a pull request if you also have the fix to the bug\.
+.SH AUTHORS
+.P
+Main contributors/maintainers to the project:
+.RS 0
+.IP \(bu 2
+0neGal mail@0negal\.com
+.IP \(bu 2
+Rémy Raes contact@remyraes\.com
+
+.RE
+
diff --git a/docs/viper.1.md b/docs/viper.1.md
new file mode 100644
index 0000000..fa531c3
--- /dev/null
+++ b/docs/viper.1.md
@@ -0,0 +1,54 @@
+viper(1) -- update and manage northstar
+=======================================
+
+## SYNOPSIS
+
+`viper` [<optional>...]
+
+## DESCRIPTION
+
+Viper is a program made to make updating and launching Northstar a lot easier. It has both a CLI and GUI tool, specifying no command line arguments opens the latter.
+
+## OPTIONS
+
+`--help`
+   Shows a brief message of all the options and what they do.
+
+`--version`
+   Various versions numbers for Node, Electron, Viper and so on.
+
+`--cli`
+   Forces the CLI to activate, meaning the GUI will never run. 
+   What purpose this has I frankly do not know.
+
+`--update`
+   Updates Northstar, this uses your `viper.json` to determine the location, it also won't try to update if the installed version of Northstar is already the newest, if you must re-install Northstar you can delete the `ns_version.txt` file in the game path.
+
+`--launch`=<version>
+   Launches Northstar, this is currently only supported on Windows.
+   If you must launch Vanilla you can run `--launch=vanilla`
+
+`--setpath`=<absolute-path>
+   Sets the game path, this'll change the `gamepath` variable in your `viper.json`, note that it only takes in absolute paths and not relative ones.
+
+## CONFIGURATION
+
+All configuration takes place in your `viper.json` file, this file may be in various locations depending on your platform, for Linux you're likely to find it at:
+
+ * `$XDG_CONFIG_HOME/viper.json`
+ * `~/.config/viper.json`
+
+On Windows it's likely to be in `%APPDATA%\viper.json`
+
+All configuration is done by Viper itself, the locale is auto set when the GUI launches through your systems locale, the gamepath is selected with `--setpath` or in the GUI.
+
+## BUGS
+
+Report bugs on the GitHub issues page, and feel free to make a pull request if you also have the fix to the bug.
+
+## AUTHORS
+
+Main contributors/maintainers to the project:
+
+ * 0neGal <mail@0negal.com>
+ * Rémy Raes <contact@remyraes.com>
diff --git a/package-lock.json b/package-lock.json
index 116bb7e..fc3dc60 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,6 +10,7 @@
 			"license": "GPL-3.0-or-later",
 			"dependencies": {
 				"follow-redirects": "^1.14.6",
+				"marked-man": "^0.7.0",
 				"request": "^2.88.2",
 				"unzipper": "^0.10.11"
 			},
@@ -2432,6 +2433,29 @@
 				"url": "https://github.com/sponsors/sindresorhus"
 			}
 		},
+		"node_modules/marked": {
+			"version": "0.7.0",
+			"resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz",
+			"integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==",
+			"peer": true,
+			"bin": {
+				"marked": "bin/marked"
+			},
+			"engines": {
+				"node": ">=0.10.0"
+			}
+		},
+		"node_modules/marked-man": {
+			"version": "0.7.0",
+			"resolved": "https://registry.npmjs.org/marked-man/-/marked-man-0.7.0.tgz",
+			"integrity": "sha512-zxK5E4jbuARALc+fIUAanM2njVGnrd9YvKrqoDHUg2XwNLJijo39EzMIg59LecHBHsIHNtPqepqnJp4SmL/EVg==",
+			"bin": {
+				"marked-man": "bin/marked-man"
+			},
+			"peerDependencies": {
+				"marked": "^0.7.0"
+			}
+		},
 		"node_modules/matcher": {
 			"version": "3.0.0",
 			"resolved": "https://registry.npmjs.org/matcher/-/matcher-3.0.0.tgz",
@@ -5493,6 +5517,18 @@
 				"semver": "^6.0.0"
 			}
 		},
+		"marked": {
+			"version": "0.7.0",
+			"resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz",
+			"integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==",
+			"peer": true
+		},
+		"marked-man": {
+			"version": "0.7.0",
+			"resolved": "https://registry.npmjs.org/marked-man/-/marked-man-0.7.0.tgz",
+			"integrity": "sha512-zxK5E4jbuARALc+fIUAanM2njVGnrd9YvKrqoDHUg2XwNLJijo39EzMIg59LecHBHsIHNtPqepqnJp4SmL/EVg==",
+			"requires": {}
+		},
 		"matcher": {
 			"version": "3.0.0",
 			"resolved": "https://registry.npmjs.org/matcher/-/matcher-3.0.0.tgz",
diff --git a/package.json b/package.json
index 5e19ef4..ca02932 100644
--- a/package.json
+++ b/package.json
@@ -18,6 +18,7 @@
 	"scripts": {
 		"start": "npx electron src/index.js",
 		"debug": "npx electron src/index.js --debug",
+		"man": "npx marked-man docs/viper.1.md > docs/viper.1",
 		"build": "npx electron-builder --win nsis --linux appimage"
 	},
 	"repository": {
@@ -26,10 +27,13 @@
 	},
 	"author": "0neGal",
 	"license": "GPL-3.0-or-later",
-	"bugs": {"url": "https://github.com/0neGal/viper/issues"},
+	"bugs": {
+		"url": "https://github.com/0neGal/viper/issues"
+	},
 	"homepage": "https://github.com/0neGal/viper#readme",
 	"dependencies": {
 		"follow-redirects": "^1.14.6",
+		"marked-man": "^0.7.0",
 		"request": "^2.88.2",
 		"unzipper": "^0.10.11"
 	},