Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Eugen committed Aug 27, 2010
1 parent 0c56486 commit ad94182
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 7 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
Simblin v0.3
------------

* decide if comments should be allowed for a blog post
* disqus comments support


Simblin v0.2
------------

Expand Down
19 changes: 18 additions & 1 deletion README.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Simblin
Simblin is built to be used by only one author. Simblin has no dashboard, no
plugin support and no theme support although the templates and css can be
modified by hand, of course. Simblin does not provide its own comment system
but has support for Disqus.
but has support for [Disqus][].

On the other hand Simblin delivers most features that are needed to provide a
good blogging experience. Simblin has
Expand Down Expand Up @@ -166,6 +166,22 @@ to register with new credentials anybody who visits the blog can register as
the admin.


### How to supply images/files with a blog post?

There is not integrated way in Simblin. I would suggest that you upload your
files/images somewhere, for instance http://files.yourdomain.com/ or dropbox
etc., and link to them appropriatly in your blog post.


### How to use comments?

Comments are provided by [Disqus][]. Head over to their website to learn more.
Basically you create an account and set the `DISQUS_SHORTNAME` option in your
`settings.py` accordingly. For further convenience you should specifiy the
`Cross-domain Receiver URL` on the Disqus settings page. Just put there
`http://yoursubdomain.yourdomain.com/does-not-exist`.


### Why another blog engine?

1. Learn about web programming in general
Expand Down Expand Up @@ -198,3 +214,4 @@ Used libraries/frameworks
[flask testing]: http://packages.python.org/Flask-Testing/
[blinker]: http://discorporate.us/projects/Blinker/
[pygments]: http://pygments.org/
[disqus]: http://www.disqus.com/
6 changes: 0 additions & 6 deletions TODO
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
* Images / File Attachments (or use dropbox? or use ftp.eugenkiss.com/blog/? is that a good idea?)
** Write Q&A that images/files should be just uploaded to a folder and linked in a blog post
* Write Q&A about disqus
** Set disqus_shortname, javascript from disqus is already embedded
** Link to website, you have to create account and register your domain
* Tab key does indent in compose editor / embed bespin
* .ico icon
* robots.txt?
* Add to config sqlalchemy pw and username for other db engines than sqlite
* Update to Flask-SQLAlchemy 0.10 and rewrite tidy_tags to use model_committed event
* Refactor(pyflakes/epydoc)/Tests/Document/Readme/Changelog
* Pingback/Traceback (or does Disqus already do that?)
Expand Down

0 comments on commit ad94182

Please sign in to comment.