aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2017-06-25 22:10:54 +0800
committerAaron LI <aly@aaronly.me>2017-06-25 22:10:54 +0800
commit170710602ceec7baf76e5a8e92da62fd9d3cc6aa (patch)
treea3cc4c70b2f99bd8a8a0583e5e4ccd769d5bde7d /README.rst
parent30ca5998c4f3c7aeed1c05a48c124664eb7e7165 (diff)
downloadfg21sim-170710602ceec7baf76e5a8e92da62fd9d3cc6aa.tar.bz2
README.rst: warn that the documentation is out-of-date!
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 76d7280..7c658dd 100644
--- a/README.rst
+++ b/README.rst
@@ -96,6 +96,10 @@ Documentations
--------------
To get started, read the `User Guide`_.
+**WARNING:**
+The documentation is *out-of-date* with the current code, and needs
+significant updates!
+
Contributions
-------------