docs(README): Add a very simple README file

This commit is contained in:
Vincent Ambo 2018-04-14 16:38:05 +02:00
parent 8c30ef92f6
commit b0825f3850
2 changed files with 18 additions and 1 deletions

14
README.org Normal file
View file

@ -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.

View file

@ -1,7 +1,10 @@
* DONE Pin *-versions in cargo.toml
* DONE Markdown support
* TODO Configurable number of DB workers
* TODO Match certain types of Diesel errors (esp. for "not found")
* TODO Sketch out categories vs. tags system
* TODO Markdown support
* TODO Quote button
* TODO Multiquote buttons
* TODO Search
* TODO Post ordering as expected
* TODO Pagination