This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "snap-website".
The branch, master has been updated
via d29d555266db06ae4b1c3a49033496305c3a62e9 (commit)
from f090587c5386d65267aef3b77ac4c12564b87fc3 (commit)
Summary of changes:
templates/docs/quickstart.md | 53 +++++++++++++++++++++++++++++++++++++++++
templates/docs/quickstart.tpl | 34 +-------------------------
templates/faq.md | 6 ++--
3 files changed, 57 insertions(+), 36 deletions(-)
create mode 100644 templates/docs/quickstart.md
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit d29d555266db06ae4b1c3a49033496305c3a62e9
Author: Gregory Collins <[email protected]>
Date: Thu Oct 21 11:31:10 2010 +0200
Update quickstart to be a markdown file, and add instructions for
installing expat dev libs
diff --git a/templates/docs/quickstart.md b/templates/docs/quickstart.md
new file mode 100644
index 0000000..7a4f6fe
--- /dev/null
+++ b/templates/docs/quickstart.md
@@ -0,0 +1,53 @@
+## Snap Quick Start Guide
+
+If you haven't already done so, first go to the [download](/download) page to
+find out how to install Snap. The installation generates an executable called
+`snap` that you can use to get started with a basic snap project. By default,
+`cabal` will install executables to "`$HOME/.cabal/bin`"; the following
+instructions assume that this directory is on your `$PATH`.
+
+Note also that before you start, you should have a development version of the
+`expat` library on your system; for instance, on Debian you would run:
+
+~~~~~~ {.shell}
+$ sudo apt-get install libexpat-dev
+~~~~~~
+
+and on Ubuntu you'd run:
+
+~~~~~~ {.shell}
+$ sudo apt-get install libexpat1-dev
+~~~~~~
+
+Mac OSX should already have the required C libraries installed. On Windows, see
+[this article by Jacob
+Stanley](http://jystic.com/2010/10/07/installing-heist-and-hexpat-on-windows/)
+for more information.
+
+To set up a new Snap project, run the following commands:
+
+~~~~~~ {.shell}
+$ mkdir myproject
+$ cd myproject
+$ snap init
+~~~~~~
+
+The `snap init` command creates a template Snap project in the current
+directory. The `Main` module for this project will be created in `src/Main.hs`.
+When you build this project with `cabal install`, an executable is created in
+`$HOME/.cabal/bin` called `myproject`. To build and run the example
+application, run the following commands:
+
+~~~~~~ {.shell}
+$ cabal install
+$ myproject 8000
+~~~~~~
+
+Now point your web browser to [http://localhost:8000/](http://localhost:8000/);
+you should see a simple response string.
+
+For more information, continue on to the [Snap API
+tutorial](tutorials/snap-api) or take a look at the [Snap
+reference documentation](/docs).
+
+
diff --git a/templates/docs/quickstart.tpl b/templates/docs/quickstart.tpl
index 6ff808c..374414a 100644
--- a/templates/docs/quickstart.tpl
+++ b/templates/docs/quickstart.tpl
@@ -2,39 +2,7 @@
<static>
<apply template="page">
<div class="singlecolumn">
-
- <h2>Snap Quick Start Guide</h2>
- <p>If you haven't already done so, first go to the
- <a href="/download">download</a> page to find out how to install Snap.
- The installation generates an executable called <code>snap</code> that
- you can use to get started with a basic snap project. By
- default, <code>cabal</code> will install executables to
- “<code>$HOME/.cabal/bin</code>”; the following instructions
- assume that this directory is on your <code>$PATH</code>.</p>
-
- <p>To set up a new Snap project, run the following commands:</p>
-
- <pre class="code">$ mkdir myproject
-$ cd myproject
-$ snap init</pre>
-
- <p>The <code>snap init</code> command creates a template Snap project in
- the current directory. The <code>Main</code> module for this project
will
- be created in <code>src/Main.hs</code>. When you build this project
with
- <code>cabal install</code>, an executable is created
- in <code>$HOME/.cabal/bin</code> called
- <code>myproject</code>. To build and run the example application, run
the
- following commands:</p>
-
- <pre class="code">$ cabal install
-$ myproject 8000</pre>
-
- <p>Now point your web browser to localhost:8000; you should see a simple
- response string.</p>
-
- <p>For more information, continue on to the
- <a href="tutorials/snap-api">Snap API tutorial</a> or take a look at
- the <a href="/docs">Snap reference documentation</a>.</p>
+ <markdown file="docs/quickstart.md"/>
</div>
</apply>
</static>
diff --git a/templates/faq.md b/templates/faq.md
index 9327ed7..72c2918 100644
--- a/templates/faq.md
+++ b/templates/faq.md
@@ -89,9 +89,9 @@ $ cabal build
### How do I install Heist on Windows?
-Heist needs a C XML library called expat. See [this
-article](http://jystic.com/2010/10/07/installing-heist-and-hexpat-on-windows/)
-by Jacob Stanley for more information.
+Heist needs a C XML library called expat. See [this article by Jacob
+Stanley](http://jystic.com/2010/10/07/installing-heist-and-hexpat-on-windows/)
+for more information.
### How do I get the libev backend working?
-----------------------------------------------------------------------
hooks/post-receive
--
snap-website
_______________________________________________
Snap mailing list
[email protected]
http://mailman-mail5.webfaction.com/listinfo/snap
