mastofe

commit: b448a3a57e64e09cbe6b311991537a12e7edf916
parent: 68fd7ee6a435c3fdef82b2b92d9e8f6f550a61aa
Author: Morgan Bazalgette <the@howl.moe>
Date:   Sun,  1 Apr 2018 23:16:36 +0200

Update README

Diffstat:
M
README.md
26
+++++++++++---------------

1 file changed, 11 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
@@ -1,16 +1,14 @@
 # Mastodon / mastofe repository
 
-Here is a fork of mastodon. We could really just remove all of the code except
-for the frontend, but to easily pull the upstream repo we'll just keep
-everything. This is my fork for the moment with the idea of making the mastofe
-just as polished as the pleromafe. If you want to get access, open an issue or
-hit me up at howl@social.zxq.co.
+This is a fork of the Mastodon repository. It was mostly created to develop the
+few changes needed to make the Mastodon Frontend, which is bundled in Pleroma
+and can be accessed by going on `/web`.
 
 # Development
 
-I use a combination of the pleroma backend + yarn + nginx to do local
-development. I refuse to install Ruby. Here's how to get it running on your own
-machine:
+I've made a few modifications to the build scripts to avoid having to install
+a single ruby gem - or ruby itself, for that matter. All you will need is
+nodejs, yarn, nginx and the pleroma backend.
 
 ## Install yarn
 
@@ -44,7 +42,7 @@ config.
 ```
 server {
     listen 80;
-    server_name pleroma.testing;
+    server_name 127.0.0.6;
 
     location /packs {
         add_header 'Access-Control-Allow-Origin' '*';
@@ -66,9 +64,7 @@ server {
 }
 ```
 
-Change the `server_name` if you like. I personally like to create a new entry
-in /etc/hosts and add `127.0.0.1 pleroma.testing`, but you do what suits you.
-
-If you have enough luck, navigating to your \<server\_name\>/web should show
-you the mastodon frontend, and should also work with all the nice things of
-webpack such as hot reloading. Have fun!
+I recommend you leave the server name on a loopback address so that your browser
+won't complain about using HTTP. In any case, once you have everything set up,
+going to `/web` should show you the frontend and should work with hot reloading.
+Have fun!