stoor 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +14 -1
- data/lib/stoor/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -18,14 +18,17 @@ Unfortunately, this will no longer work on Ruby 1.8.7, because `gollum-lib` now
|
|
18
18
|
|
19
19
|
gem install stoor
|
20
20
|
|
21
|
+
(On occasion I have had to `rbenv rehash`.)
|
22
|
+
|
21
23
|
## Usage examples
|
22
24
|
|
23
25
|
(Relax, the client id and secret below are fake.)
|
24
26
|
|
25
27
|
### The 'stoor' command
|
26
28
|
|
27
|
-
To get started, type:
|
29
|
+
To get started, change directory to your git repo where your wiki content lives, and type the `stoor` command:
|
28
30
|
|
31
|
+
cd wiki
|
29
32
|
stoor
|
30
33
|
|
31
34
|
This will run your gollum wiki on port 3000, though it will decorate the footer with a message saying who
|
@@ -34,6 +37,16 @@ the values for the GitHub commit will be what you see in `git config -l`).
|
|
34
37
|
|
35
38
|
The `stoor` command is a thin wrapper around the `thin` web server, and takes all `thin` options (`-p <port>`, etc.).
|
36
39
|
|
40
|
+
If you get the error `Gollum::InvalidGitRepositoryError` it means that you didn't change your directory to
|
41
|
+
a git repo.
|
42
|
+
|
43
|
+
If you don't have a repo yet for your wiki . . .
|
44
|
+
|
45
|
+
mkdir mywiki
|
46
|
+
cd mywiki
|
47
|
+
git init .
|
48
|
+
stoor
|
49
|
+
|
37
50
|
### Specify the Wiki repo location
|
38
51
|
|
39
52
|
WIKI_PATH=/Users/admin/wiki stoor
|
data/lib/stoor/version.rb
CHANGED