Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added section on why a rewrite?

  • Loading branch information...
commit 8c962e69e3dce59e5d9523b96eed42db677895ee 1 parent 7d25e61
@jgm jgm authored
Showing with 17 additions and 2 deletions.
  1. +17 −2 README.markdown
View
19 README.markdown
@@ -15,13 +15,28 @@ If you run gitit2 from the source directory, a default
on the settings in `settings.yaml`. You will then be able
to view your wiki at <http://localhost:3000>.
+Why a rewrite?
+--------------
+
+The old code base was ugly, for a variety of reasons, including
+the fact that it dates from an early phase in happstack's history
+(when many things that are easy now were hard) and an early phase
+in the author's Haskell experience. Yesod provides abstractions,
+such as type safe routes, that make many of the ugly parts go away.
+The new code base should be much smaller, easier to modify, and
+easier to be confident in.
+
+gitit2 is implemented as a Yesod subsite, making it trivial
+to embed a gitit wiki in a Yesod application.
+
+What is still missing?
+----------------------
+
The basic wiki functions have all been implemented. You can
create, edit, and modify pages. You can search, view
history, and comment. You can export in any format that
pandoc supports.
-What is still missing?
-
* User login -- currently there is no access control.
* Preview in edit.
* Loading plugins (the plugin API works, but there is not
Please sign in to comment.
Something went wrong with that request. Please try again.