summaryrefslogtreecommitdiffstats
path: root/common/README.md
diff options
context:
space:
mode:
authorNicolas Lécureuil <neoclust@mageia.org>2020-05-17 14:46:00 +0200
committerNicolas Lécureuil <neoclust@mageia.org>2020-05-17 14:46:00 +0200
commite3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa (patch)
tree336981502f93ceb9fa5ed33ea3b47dcefc5a8402 /common/README.md
parentff32e499745367b816d10f25e63ff3328214c32f (diff)
downloadplanet-e3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa.tar
planet-e3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa.tar.gz
planet-e3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa.tar.bz2
planet-e3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa.tar.xz
planet-e3de9d7dd1331f9718e04cc98e9ca7cfa27cf4aa.zip
Sync with master of moonmoon ( version 9.0.0-rc)HEADuser/wally/upstream-10-devmaster
Source from https://github.com/Emmafrs/moonmoon/
Diffstat (limited to 'common/README.md')
-rw-r--r--common/README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/common/README.md b/common/README.md
new file mode 100644
index 0000000..0fcfda0
--- /dev/null
+++ b/common/README.md
@@ -0,0 +1,66 @@
+<p align="center">
+ <img src="https://github.com/moonmoon/moonmoon/raw/master/custom/img/moonmoon%40128w.png">
+</p>
+
+
+moonmoon [![Build Status](https://travis-ci.org/moonmoon/moonmoon.svg?branch=master)](https://travis-ci.org/moonmoon/moonmoon)
+========
+
+Moonmoon is a web based aggregator similar to planetplanet.
+It can be used to blend articles from different blogs with same interests into a single page.
+
+Moonmoon is simple: it only aggregates feeds and spits them out in one single page.
+It does not archive articles, it does not do comments nor votes.
+
+Requirements
+------------
+You will need a web hosting with at least PHP 5.6 (PHP 7 is also supported).
+
+If you are installing moonmoon on a Linux private server (VPS, dedicated host),
+please note that you will need to install the package `php-xml`.
+
+Installing
+----------
+
+Installation steps (shared hosting or virtual / dedicated server) can be found
+[in the wiki](https://github.com/moonmoon/moonmoon/wiki/How-to-install).
+
+Docker images are also available in [moonmoon/docker-images](https://github.com/moonmoon/docker-images).
+Theses images are probably not production-ready but should work for manual testing.
+
+Contributing
+------------
+
+You want to contribute to moonmoon? Perfect! [We wrote some guidelines to help you
+craft the best Issue / Pull Request possible](https://github.com/moonmoon/moonmoon/blob/master/CONTRIBUTING.md),
+don't hesitate to take a look at it :-)
+
+License
+-------
+
+Moonmoon is free software and is released under the [BSD license](https://github.com/moonmoon/moonmoon/blob/master/LICENSE).
+Third-party code differently licensed is included in this project, in which case mention is always made of
+the applicable license.
+
+[The logo](https://github.com/moonmoon/moonmoon/raw/master/custom/img/moonmoon.png) was designed by [@rakujira](https://twitter.com/rakujira).
+
+Configuration options
+---------------------
+After installation, configuration is kept in a YAML formatted `custom/config.yml`:
+
+```%yaml
+url: http://planet.example.net # your planet base URL
+name: My Planet # your planet front page name
+locale: en # front page locale
+items: 10 # how many items to show
+refresh: 240 # feeds cache timeout (in seconds)
+cache: 10 # front page cache timeout (in seconds)
+cachedir: ./cache # where is cache stored
+postmaxlength: 0 # deprecated
+shuffle: 0 # deprecated
+nohtml: 0 # deprecated
+categories: # only list posts that have one
+ # of these (tag or category)
+debug: false # debug mode (dangerous in production!)
+checkcerts: true # check feeds certificates
+```