Polish up open source release

This commit is contained in:
Noah 2022-08-25 22:03:39 -07:00
parent bbc6e354e2
commit 0690a9a5b0
8 changed files with 26 additions and 8 deletions

View File

@ -6,7 +6,7 @@ License.
This website is open source and if you'd like to help work on it (fix bugs 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 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. [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
## Dependencies ## Dependencies
@ -22,12 +22,21 @@ web app is primarily designed for that.
## Building the App ## 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 setup`: install Go dependencies
* `make build`: builds the program to ./nonshy * `make build`: builds the program to ./nonshy
* `make run`: run the app from Go sources in debug mode * `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 ## Configuring
On first run it will generate a `settings.json` file in the current On first run it will generate a `settings.json` file in the current

Binary file not shown.

After

Width:  |  Height:  |  Size: 821 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

View File

@ -107,7 +107,7 @@
</p> </p>
</div> </div>
<div class="columns"> <div class="columns mb-5">
<div class="column is-narrow"> <div class="column is-narrow">
<div class="box"> <div class="box">
<div class="media"> <div class="media">
@ -128,6 +128,15 @@
</div> </div>
</div> </div>
<div class="content block pt-1">
<h3><i class="fa fa-code"></i> This website is open source!</h3>
<p>
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
<a href="https://code.nonshy.com/nonshy/website" target="_blank">code.nonshy.com</a>.
</p>
</div>
</div> </div>
{{end}} {{end}}

View File

@ -224,11 +224,11 @@
<h3>Is this website open source?</h3> <h3>Is this website open source?</h3>
<p> <p>
Yes! The source code is currently hosted on the author's personal Git server. It Yes! The source code for this website is released as free software under the GNU
will eventually have a GitHub mirror and accept pull requests from the community. General Public License. It is programmed in Go and the source code is available
In the mean time, contact the site owner to get a link to the public git repo. at <a href="https://code.nonshy.com/nonshy/website" target="_blank">code.nonshy.com/nonshy/website</a>.
This site is programmed in the Go language and released under the GNU General Public If you're a developer and would like to contribute bug fixes or new features to
License. the website, see details <a href="https://code.nonshy.com/nonshy/website/src/branch/main/CONTRIBUTING.md" target="_blank">here</a>.
</p> </p>
</div> </div>
</div> </div>