about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@gmail.com>2018-04-14T14·38+0200
committerVincent Ambo <tazjin@gmail.com>2018-04-14T14·38+0200
commitb0825f3850a0f6fc97f05a02fa9f30aefee7a158 (patch)
tree0a116f3e901cefea41ba9588dbd44c4e97a0f578 /README.org
parent8c30ef92f652f411679408344031706745346f02 (diff)
docs(README): Add a very simple README file
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 000000000000..46df507c32ad
--- /dev/null
+++ b/README.org
@@ -0,0 +1,14 @@
+#+TITLE: Converse
+#+AUTHOR: Vincent Ambo
+
+Welcome to Converse, a work-in-progress forum software written in
+Rust. The intention behind Converse is to provide a simple forum-like
+experience.
+
+There is not a lot of documentation about Converse yet and it has
+several known issues. Also note that Converse is being developed for a
+specific use-case and is not going to be a forum feature kitchen-sink
+like most classical forum softwares.
+
+Better documentation is forthcoming once the remaining basics have
+been taken care of.