Commits

Markus Zapke-Gründemann  committed 3d503d8

Updated and translated README.

Translated README from German to English.
Added information how to create a Vagrant VM.
Added repository, issue tracker and licensing information.

  • Participants
  • Parent commits 2924652

Comments (0)

Files changed (2)

File README

-Der Django Workshop ist ein freies deutsches Django Tutorial.
-
-Der Django-Workshop soll beim Einstieg in die Arbeit mit dem Web Application
-Framework Django helfen. Er kann sowohl als Tutorial zum Selbststudium als
-auch für Schulungen benutzt werden.
+***************
+Django Workshop
+***************
+
+Django Workshop is a free Django_ tutorial.
+
+The goal of the tutorial is to help beginners to learn the basics of the
+Python Web Application Framework Django. It can also help people with
+basic Django experience to improve their skills.
+
+The workshop has been created as material for Django trainings but can
+also be used for self-study.
+
+Currently there is only a German version available. An English
+translation is in progress.
+
+.. _Django: https://www.djangoproject.com/
+
+Creating a Virtual Machine using Vagrant
+========================================
+
+The repository contains a configuration for a Virtual Machine. This
+configuration will install all necessary software during setup. It's a
+Debian GNU/Linux 6.0 system. The following packages will be installed
+using Chef_:
+
+* Vim
+* tree
+* Sqlite
+* MySQL
+* PostgreSQL
+
+To setup the Virtual Machine you have to install Vagrant_ and Librarian_
+at first::
+
+    $ gem install vagrant librarian
+    $ librarian-chef install
+    $ vagrant up
+
+..  note::
+
+    If you use Linux or OS X you may need *root* permissions to install
+    Vagrant and Librarian.
+
+Now you can connect to the Virtual Machine using ``ssh``::
+
+    $ vagrant ssh
+
+After that you can connect to the MySQL and PostgreSQL. Use the password
+"django" to authenticate::
+
+    $ mysql -p -u root
+    $ psql -h localhost -U postgres
+
+.. _Chef: http://community.opscode.com/
+.. _Vagrant: http://vagrantup.com/
+.. _Librarian: https://github.com/applicationsonline/librarian
+
+Contributions and Bugs
+======================
+
+Feel free to improve Django Workshop or create translations. `Pull
+requests are welcome!`_
+
+Please report problems to our `issue tracker`_.
+
+.. _Pull requests are welcome!: https://bitbucket.org/keimlink/django-workshop
+.. _issue tracker: https://bitbucket.org/keimlink/django-workshop/issues?status=new&status=open
+
+Documentation License
+=====================
+
+This work is licensed under the Creative Commons Attribution-ShareAlike
+3.0 Unported License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to
+Creative Commons, 444 Castro Street, Suite 900, Mountain View,
+California, 94041, USA.
+
+
+Source Code License
+===================
+
+Copyright (c) 2010-2012, Markus Zapke-Gründemann
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in
+      the documentation and/or other materials provided with the
+      distribution.
+    * Neither the names of the authors nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+