1
0
Fork 0
mirror of https://github.com/Eggbertx/gochan.git synced 2025-08-01 22:26:24 -07:00

Forgot to remove refactoring disclaimer in README

This commit is contained in:
Eggbertx 2021-08-01 23:00:53 -07:00
parent 225d7fb6d3
commit 3396f0c69f

View file

@ -1,11 +1,7 @@
Gochan
=======
**NOTE**: I am currently working on refactoring configuration, use `master` for non-broken code until this branch is merged into it.
A semi-standalone imageboard server written in Go
Gochan works in a manner similar to Kusaba X, Tinyboard and others. As such, Gochan generates static HTML files which can optionally be served by a separate web server.
Gochan is an imageboard server with a backend written in Go. It works in a manner similar to Kusaba X, Tinyboard and others. As such, Gochan generates static HTML files which can optionally be served by a separate web server.
Demo installation: https://gochan.org
@ -48,13 +44,13 @@ See [`sass/README.md`](sass/README.md) for information on working with Sass and
# Development
## Styleguide
* Follow the standard go styleguide
## Style guide
* For Go source, follow the standard Go [style guide](https://github.com/golang/go/wiki/CodeReviewComments).
* All exported functions and variables should have a documentation comment explaining their functionality, as per go style guides.
* Unexported functions are preferred to have a documentation comment explaining it, unless it is sufficiently self explanatory or simple.
* Git commits should be descriptive. Put further explanation in the comment of the commit.
* Function names should not be *too* long
* Avoid single letter variables, use descriptive variables names if possible, within reason
* Function names should not be *too* long.
* Avoid single letter variables except for simple things like iterator ints, use descriptive variables names if possible, within reason.
## Roadmap