1. Curtis Maloney
  2. gnocchi-ask

Commits

cur...@tinbrain.net  committed 9981b35

Updated doco

  • Participants
  • Parent commits 10fa61b
  • Branches default

Comments (0)

Files changed (3)

File README

View file
  • Ignore whitespace
+A simple community "question and answer" system [like AskBot, Stack Overflow, et
+ al]
+
+Allows users to ask questions, answer questions, vote up/down the responses, and
+ "accept" the response they most like.

File TODO

View file
  • Ignore whitespace
 Write docs.
 
 Add views for question/response moderation
+Allow admins to see non-visible questions/answers
+
 Add views for editing questions
+
+Support tag filtering

File docs/INSTALL

View file
  • Ignore whitespace
+# INSTALL
+
+Installation is simply done using pip:
+
+    pip install gnocchi-ask.tar.gz
+
+Pre-requisites:
+
+Obviously, it depends on Django, and also django-taggit for tagging.
+
+Then, add it to your installed apps:
+
+    INSTALLED_APPS = [
+        ...
+        'gnocchi_ask',
+        'django-taggit',
+    ]
+
+and syncdb.
+
+There are 3 templates required:
+
+- gnocchi_ask/question_list.html
+
+    The main view page.  This is implemented using an "object_list" generic
+    view.  Pagination is set by default at 10, adjustable with the QUESTION_PAGE
+    setting.
+
+- gnocchi_ask/question_detail.html
+
+    View of a question.  Since this uses the "object_detail" generic view, the
+    selected question is in the context as "object".
+
+    Also in context is an AddResponseForm form, as 'form',
+
+- gnocchi_ask/question_ask.html
+
+    Used for entering a new question.