diff options
author | Vincent Ambo <tazjin@gmail.com> | 2018-04-14T14·38+0200 |
---|---|---|
committer | Vincent Ambo <tazjin@gmail.com> | 2018-04-14T14·38+0200 |
commit | b0825f3850a0f6fc97f05a02fa9f30aefee7a158 (patch) | |
tree | 0a116f3e901cefea41ba9588dbd44c4e97a0f578 | |
parent | 8c30ef92f652f411679408344031706745346f02 (diff) |
docs(README): Add a very simple README file
-rw-r--r-- | README.org | 14 | ||||
-rw-r--r-- | todo.org | 5 |
2 files changed, 18 insertions, 1 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. diff --git a/todo.org b/todo.org index 63ad4ebb0645..d417b571ad5c 100644 --- a/todo.org +++ b/todo.org @@ -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 |