aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2016-05-18 19:19:06 +0200
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2016-05-18 19:20:11 +0200
commitee0c0a7256b64b1ac2dd46436a7b627eb08c7724 (patch)
tree18c380a5d4c20178be8f29237ae2a0670a19520a /README.md
parent4230e93c64c78ca4276a164704c8dc8a67e466e1 (diff)
downloadblogc-ee0c0a7256b64b1ac2dd46436a7b627eb08c7724.tar.gz
blogc-ee0c0a7256b64b1ac2dd46436a7b627eb08c7724.tar.bz2
blogc-ee0c0a7256b64b1ac2dd46436a7b627eb08c7724.zip
updated README.md with dependencies. closes #4
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index d5b968e..74b96f8 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@ A blog compiler.
Clone the [Git repository](https://github.com/blogc/blogc) or grab the [latest release](https://github.com/blogc/blogc/releases) and extract it.
+If installing from Git repository, [ronn](https://github.com/rtomayko/ronn) and [GNU Autotools](http://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html) must be installed in the machine. Release tarballs does not have these dependencies and are the recommended way to install.
+
Inside the source directory, run the following commands:
$ ./autogen.sh # if installing from git
@@ -16,7 +18,7 @@ Inside the source directory, run the following commands:
$ make
# make install
-The `./configure` options listed above will enable building of helper tools. To learn more about these tools, please read the man pages.
+The `./configure` options listed above will enable building of helper tools. To learn more about these tools, please read the man pages. Be aware that [`blogc-runserver(1)`](https://blogc.rgm.io/man/blogc-runserver.1.html) depends on [libmagic](https://github.com/file/file) and [libevent](http://libevent.org/), but this tool can be replaced by any HTTP server you want to use.
To create your first blog, please clone our example repository and adapt it to your needs: