summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornashe <thomas@chauchefoin.fr>2017-07-15 15:00:37 +0100
committernashe <thomas@chauchefoin.fr>2017-07-15 15:00:37 +0100
commit7b95af384d69ddcc3c74791f3d5cc4770135e860 (patch)
treea09b47c80adb463b4cb47f1789456a2086c4a698
parent1715a884707408d147cc7b16e3b39e441e8bc03e (diff)
downloadplanet-7b95af384d69ddcc3c74791f3d5cc4770135e860.tar
planet-7b95af384d69ddcc3c74791f3d5cc4770135e860.tar.gz
planet-7b95af384d69ddcc3c74791f3d5cc4770135e860.tar.bz2
planet-7b95af384d69ddcc3c74791f3d5cc4770135e860.tar.xz
planet-7b95af384d69ddcc3c74791f3d5cc4770135e860.zip
Update README.md
-rw-r--r--README.md (renamed from README.markdown)35
1 files changed, 11 insertions, 24 deletions
diff --git a/README.markdown b/README.md
index afa443e..fe0d919 100644
--- a/README.markdown
+++ b/README.md
@@ -13,37 +13,26 @@ 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 not that you
-will need to install the package `php-xml`.
+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
----------
-#### On a shared hosting
+Installation steps (shared hosting or virtual / dedicated server) can be found
+[in the wiki](https://github.com/moonmoon/moonmoon/wiki/How-to-install).
-* Fetch a copy of the sources:
- - The last version, by downloading https://github.com/moonmoon/moonmoon/archive/master.zip (warning, it may be instable!);
- - The last release, by going on https://github.com/moonmoon/moonmoon/releases and downloading the last stable one.
-* Extract the zip file on your computer
-* Upload the extracted files your shared hosting server using your FTP client. If your hosting provider offers FTP and SFTP, prefer the last one, as the connection will be established over a secure channel.
-* Go to `http(s)://yourdomain.tld/install.php` with your browser
-* Profit!
-
-#### On a dedicated server (where a web server is already installed)
+Contributing
+------------
-* Download composer: `wget https://getcomposer.org/composer.phar`
-* Fetch a copy of the sources:
- - The last version, by downloading a copy of `master`: `wget https://github.com/moonmoon/moonmoon/archive/master.zip` (warning, it may be instable!);
- - The last release, by going on https://github.com/moonmoon/moonmoon/releases and downloading the last stable one.
-* Extract the files by running: `unzip <thefile.zip>`
-* Inside the extracted repository, run ` php composer.phar install --no-dev`
-* Go to `http(s)://yourserver.tld/install.php` with your browser
-* Profit!
+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/CONTRIBUTING.md),
+don't hesitate to take a look at it :-)
License
-------
-Moonmoon is free software and is released under BSD license.
+Moonmoon is free software and is released under BSD license.
Configuration options
---------------------
@@ -64,6 +53,4 @@ categories: # only list posts that have one
# of these (tag or category)
debug: false # debug mode (dangerous in production!)
checkcerts: true # check feeds certificates
-```
-
----
+``` \ No newline at end of file