diff --git a/README.md b/README.md index 62f9552..0ab01b4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ License. This website is open source and if you'd like to help work on it (fix bugs or contribute new features), you may sign up an account on the -[code.nonshy.com](https://code.nonshy.com/). See the +[code.nonshy.com](https://code.nonshy.com/) server. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for details. ## Dependencies @@ -22,12 +22,21 @@ web app is primarily designed for that. ## Building the App -Use the Makefile: +This app is written in Go: [go.dev](https://go.dev). You can probably +get it from your package manager, e.g. + +* macOS: `brew install golang` with homebrew: [brew.sh](https://brew.sh) +* Linux: it's in your package manager, e.g. `apt install golang` + +Use the Makefile (with GNU `make` or similar): * `make setup`: install Go dependencies * `make build`: builds the program to ./nonshy * `make run`: run the app from Go sources in debug mode +Or read the Makefile to see what the underlying `go` commands are, +e.g. `go run cmd/nonshy/main.go web` + ## Configuring On first run it will generate a `settings.json` file in the current diff --git a/web/static/img/favicon-16.png b/web/static/img/favicon-16.png new file mode 100644 index 0000000..ed3faed Binary files /dev/null and b/web/static/img/favicon-16.png differ diff --git a/web/static/img/favicon-32.png b/web/static/img/favicon-32.png new file mode 100644 index 0000000..65d01fa Binary files /dev/null and b/web/static/img/favicon-32.png differ diff --git a/web/static/img/favicon-48.png b/web/static/img/favicon-48.png new file mode 100644 index 0000000..cd6e758 Binary files /dev/null and b/web/static/img/favicon-48.png differ diff --git a/web/static/img/favicon-64.png b/web/static/img/favicon-64.png new file mode 100644 index 0000000..6daf97c Binary files /dev/null and b/web/static/img/favicon-64.png differ diff --git a/web/static/img/shy.png b/web/static/img/shy.png index a957fb6..ef845c2 100644 Binary files a/web/static/img/shy.png and b/web/static/img/shy.png differ diff --git a/web/templates/about.html b/web/templates/about.html index efef875..eb525cc 100644 --- a/web/templates/about.html +++ b/web/templates/about.html @@ -107,7 +107,7 @@

-
+
@@ -128,6 +128,15 @@
+
+

This website is open source!

+

+ If you would like to see the source code or contribute bug fixes or new features, the + source code behind this website is available at + code.nonshy.com. +

+
+
{{end}} \ No newline at end of file diff --git a/web/templates/faq.html b/web/templates/faq.html index 13f483d..4b0c374 100644 --- a/web/templates/faq.html +++ b/web/templates/faq.html @@ -224,11 +224,11 @@

Is this website open source?

- Yes! The source code is currently hosted on the author's personal Git server. It - will eventually have a GitHub mirror and accept pull requests from the community. - In the mean time, contact the site owner to get a link to the public git repo. - This site is programmed in the Go language and released under the GNU General Public - License. + Yes! The source code for this website is released as free software under the GNU + General Public License. It is programmed in Go and the source code is available + at code.nonshy.com/nonshy/website. + If you're a developer and would like to contribute bug fixes or new features to + the website, see details here.