README: Add some troubleshooting info for compilation issues.
authorlain <lain@soykaf.club>
Fri, 19 Jun 2020 13:49:34 +0000 (15:49 +0200)
committerlain <lain@soykaf.club>
Fri, 19 Jun 2020 13:49:34 +0000 (15:49 +0200)
README.md

index 7fc1fd381ffbabaad5bed749b310bb579c10bb79..6ca3118fbeaea91c39352dc0d9f73346317f58d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,6 +34,16 @@ Currently Pleroma is not packaged by any OS/Distros, but if you want to package
 ### Docker
 While we don’t provide docker files, other people have written very good ones. Take a look at <https://github.com/angristan/docker-pleroma> or <https://glitch.sh/sn0w/pleroma-docker>.
 
+### Compilation Troubleshooting
+If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:
+
+- `mix deps.clean --all`
+- `mix local.rebar`
+- `mix local.hex`
+- `rm -r _build`
+
+If you are not developing Pleroma, it is better to use the OTP release, which comes with everything precompiled.
+
 ## Documentation
 - Latest Released revision: <https://docs.pleroma.social>
 - Latest Git revision: <https://docs-develop.pleroma.social>