From 18ef84167248230ec0c28fd58a101f9ed5989c78 Mon Sep 17 00:00:00 2001
From: "Phyks (Lucas Verney)" <phyks@phyks.me>
Date: Thu, 27 Apr 2017 11:41:51 +0200
Subject: [PATCH] Update doc

---
 README.md                | 17 +++++------------
 doc/0.getting_started.md |  9 +++++++++
 2 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 9295f9f..a0831e2 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,10 @@ database schema could change at any time. Do not consider it as being
 production ready. However, I am currently using it for my own housing search
 and it is working fine :)
 
+**Note**: For the moment, it requires [this MR on
+Weboob](https://git.weboob.org/weboob/devel/merge_requests/31) which has not
+yet been merged.
+
 
 It uses [Weboob](http://weboob.org/) to get all the housing posts on most of
 the websites offering housings posts, and then offers a bunch of pipelines to
@@ -32,18 +36,7 @@ This code is not restricted to handling flats only!
 
 ## Getting started
 
-1. Clone the repository.
-2. Install required Python modules: `pip install -r requirements.txt`.
-3. Init a configuration file: `python -m flatisfy init-config > config.json`.
-   Edit it according to your needs (see doc).
-4. Build the required data files:
-   `python -m flatisfy build-data --config config.json`.
-5. Use it to `fetch` (and output a filtered JSON list of flats) or `import`
-   (into an SQLite database, for the web visualization) a list of flats
-   matching your criteria.
-6. Install JS libraries and build the webapp:
-   `npm install && npm run build:dev` (use `build:prod` in production).
-7. Use `python -m flatisfy serve --config config.json` to serve the web app.
+See the [getting started guide](doc/0.getting_started.md).
 
 
 ## Documentation
diff --git a/doc/0.getting_started.md b/doc/0.getting_started.md
index 1953fce..d299121 100644
--- a/doc/0.getting_started.md
+++ b/doc/0.getting_started.md
@@ -1,6 +1,15 @@
 Getting started
 ===============
 
+**Important**: Flatisfy relies on [Weboob](http://weboob.org/) to fetch
+housing posts from housing websites. Then, you should install the [`devel`
+branch](https://git.weboob.org/weboob/devel/) and update it regularly,
+especially if Flatisfy suddenly stops fetching housing posts.
+
+**Note**: For the moment, it requires [this MR on
+Weboob](https://git.weboob.org/weboob/devel/merge_requests/31) which has not
+yet been merged.
+
 ## TL;DR
 
 1. Clone the repository.