diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index e69de29..1e2bc13 100644 --- a/docs/source/quick_start.rst +++ b/docs/source/quick_start.rst @@ -0,0 +1,54 @@ +.. _quick_start: + +Quick Start +=========== +Here we will cover the basics for a small project in Pecan. More advanced +examples and methods are not covered here. + +.. note:: + We will not cover how to get Pecan installed here. If you need installation + details please go to :ref:`installation` + + +We include a basic template to have a good layout for a Pecan project. This is +accomplished by ``PasteScript`` so we need to invoke a command to create our +example project:: + + $ paster create -t pecan-base + +The above commnad will prompt you for a project name. I chose *test_project*, +this is how it looks like when we run the whole command:: + + $ paster create -t pecan-base + Selected and implied templates: + pecan#pecan-base Template for creating a basic Framework package + + Enter project name: test_project + Variables: + egg: test_project + package: test_project + project: test_project + Creating template pecan-base + Creating directory ./test_project + Recursing into +egg+ + Creating ./test_project/test_project/ + Copying __init__.py to ./test_project/test_project/__init__.py + Recursing into controllers + Creating ./test_project/test_project/controllers/ + Copying __init__.py to ./test_project/test_project/controllers/__init__.py + Copying root.py to ./test_project/test_project/controllers/root.py + Recursing into templates + Creating ./test_project/test_project/templates/ + Copying index.html to ./test_project/test_project/templates/index.html + Copying layout.html to ./test_project/test_project/templates/layout.html + Copying success.html to ./test_project/test_project/templates/success.html + Recursing into public + Creating ./test_project/public/ + Recursing into css + Creating ./test_project/public/css/ + Copying style.css to ./test_project/public/css/style.css + Recursing into javascript + Creating ./test_project/public/javascript/ + Copying shared.js to ./test_project/public/javascript/shared.js + Copying start.py_tmpl to ./test_project/start.py +