projects
/
bloat
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
2f4cd26
)
Update readme
author
r
<r@freesoftwareextremist.com>
Wed, 1 Jan 2020 11:39:46 +0000
(11:39 +0000)
committer
r
<r@freesoftwareextremist.com>
Wed, 1 Jan 2020 11:49:12 +0000
(11:49 +0000)
README
patch
|
blob
|
history
diff --git
a/README
b/README
index 817f818d66baa6a33df99144d213640bb78fb48b..d0e11dd676b8d0b66ce050ad4e6584472cedc220 100644
(file)
--- a/
README
+++ b/
README
@@
-1,4
+1,4
@@
-Web - A web client for Mastodon Network
+Web - A web client for Mastodon Network
[1]
Features:
Features:
@@
-18,24
+18,26
@@
External dependencies:
Building and Installation:
Building and Installation:
-Make sure you have GO installed. Other dependencies will be
-
downloaded
automatically.
+Make sure you have GO installed. Other dependencies will be
downloaded
+automatically.
Typing make will build the binary
$ make
Typing make will build the binary
$ make
-Edit the provided config file. See the default.conf file for more details.
+Edit the provided config file. See the default.conf file for more details.
$ ed default.conf
Run the binary
$ ./web
$ ed default.conf
Run the binary
$ ./web
-You can also setup a reverse HTTP proxy serve the website over TLS connection.
+You can now access the frontend at http://localhost:8080, which is the default
+listen address. You can also setup a reverse HTTP proxy to serve the frontend over
+TLS connection.
Notes:
Notes:
-You will need to clear the database if you change config values for client_name,
+A database reset is required after changing the values of config options client_name,
client_scope or client_website.
client_scope or client_website.
@@
-46,4
+48,7
@@
related and neighboring rights to this software to the public domain worldwide.
This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with
This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with
-this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
+
+
+[1] https://pleroma.social