Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 88 lines (53 sloc) 2.409 kB
5a16b8e @adamwiggins readme for setup
authored
1 = Scanty, a really small blog
2
3 == Overview
4
1f541a8 @adamwiggins readme tweaks
authored
5 Scanty is blogging software. Software for my blog, to be exact:
5a16b8e @adamwiggins readme for setup
authored
6 http://adam.blog.heroku.com
7
8 It is not a blogging engine, but it's small and easy to modify, so it could be
9 the starting point for your blog, too.
10
11 == Features
12
13 * Posts (shock!)
14 * Tags
40e289f @adamwiggins dependency doc update
authored
15 * Markdown (via Maruku)
5a16b8e @adamwiggins readme for setup
authored
16 * Ruby code syntax highlighting (via Syntax)
17 * Atom feed
18 * Comments via Disqus
19 * Web framework = Sinatra
20 * ORM = Sequel
21
22 == Dependencies
23
40e289f @adamwiggins dependency doc update
authored
24 $ gem install sinatra
25
26 Sequel, Maruku, and Syntax are all vendored.
5a16b8e @adamwiggins readme for setup
authored
27
28 == Setup
29
30 Edit main.rb and change the Blog config struct at the top to your liking. For
1f541a8 @adamwiggins readme tweaks
authored
31 security purposes, change the admin password and the admin cookie key and
32 value. These last two can be set to any random value you like, just choose
33 something other than the default.
5a16b8e @adamwiggins readme for setup
authored
34
35 Then run the server:
36
37 $ ruby main.rb
38
3d13293 readme url fix
Adam Wiggins authored
39 And visit: http://localhost:4567
5a16b8e @adamwiggins readme for setup
authored
40
41 Log in with the password you selected, then click New Post. The rest should be
42 self-explanatory.
43
44 In production, you'll probably want to run "rake start" to start (and restart)
45 the server. Change the value of "port" at the top of the Rakefile to run on a
46 different port.
47
48 == Database
49
50 The default is a SQLite file named blog.db. To use something else, set
51 DATABASE_URL in your environment when running the app, i.e.:
52
53 $ DATABASE_URL='mysql://localhost/myblog' ruby main.rb
54
55 Or, modify the Sequel.connect statement at the top of main.rb.
56
57 The database will be created automatically when the server is executed.
58
d96f5e4 @adamwiggins disqus comments cofigurable
authored
59 == Comments
60
61 There are no comments by default. If you wish to activate comments, create an
62 account and a website on Disqus (disqus.com) and enter the website shortname as
63 the :disqus_shortname value in the Blog config struct.
64
b8fe1e6 @adamwiggins docs for importing
authored
65 == Import data
66
67 Christopher Swenson has a Wordpress importer: http://github.com/swenson/scanty_wordpress_import
68
69 Other kinds of data can be imported easily, take a look at the rake task :import for an example of loading from a YAML file with field names that match the database schema.
70
5a16b8e @adamwiggins readme for setup
authored
71 == Customize
72
73 There are no themes or settings beyond the basic ones in the Blog struct. Just
74 edit the CSS or the code as you see fit.
75
76 == Meta
77
78 Written by Adam Wiggins
79
88af43d @adamwiggins credits update
authored
80 Patches contributed by: Christopher Swenson, S. Brent Faulkner, and Stephen Eley
86021e1 @adamwiggins credits update
authored
81
5a16b8e @adamwiggins readme for setup
authored
82 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
83
3d13293 readme url fix
Adam Wiggins authored
84 http://github.com/adamwiggins/scanty
5a16b8e @adamwiggins readme for setup
authored
85
3d13293 readme url fix
Adam Wiggins authored
86 http://adam.blog.heroku.com
5a16b8e @adamwiggins readme for setup
authored
87
Something went wrong with that request. Please try again.