Commits

Dmitri Lebedev committed 70541b4

updated docs

  • Participants
  • Parent commits f690a33
  • Branches coffee-script

Comments (0)

Files changed (3)

 40ba8693fb49b54e84a875750409270e4f84cbbe culebron-hamlpy
 cf0002777f266b4c9f65938b4953d23bf420cd0b gp.recipe.node
 6e481bc18fea7cae253977ad6b1d9a5bf85a6d24 project/static/css/oocss
-32114d3d93246c55454e7ed9622abcdc2ec8b614 wiki
+fa0976d748d05a3bc5f228e8992994adc1e250d4 wiki
 Clone the project:
 
     hg clone https://hg.bitbucket.org/siberiano/fastdev-django yourproject
-
-If you want to develop your own project, disconnect it from my repo:
-
     rm yourproject/.hg/hgrc
 
-If you want to contribute to fastdev, then don't.
+If you want to use **CoffeeScript**, read section "CoffeeScript" below.
 
 Usage
 =====
 ============
 
  - Python 2.5+
- - Ruby 1.8+ (for Sass)
- - SQLite 3 or any database of choice
+ - rubygems (for Sass)
+ - Database of your choice
 
 All the other packages are bundled in the buildout script.
 
 
         .footer
             - trans 'See you'
- 
+
  - **Django Compressor and Sass**
 
 Compressor can be used to transform and compress CSS and JS on the fly. Here it
 A **not included** feature: it can parse `script` tags in the page, open the JS
 files, minify them and pack into one single file.
 
+ - **CoffeeScript**
+
+If you want to use CoffeeScript, do the following:
+
+ - edit Makefile and uncomment the line `run: bin/coffee`
+ - set `USE_COFFEE_SCRIPT = True` in settings.py
+ - if you use Ubuntu, make sure curl is installed (by default it is not):
+
+    sudo apt-get install curl
+
+You **DON'T NEED** [Node.js][6], nor [npm][7] for this project to run
+CoffeeScript. Buildout will install them automatically. This makes it easier
+to deploy in web hosting.
+
  - **Webfaction**
 
 To make a WSGI script for Webfaction hosting, run
   [3]: https://bitbucket.org/siberiano/fastdev-django/wiki/Makefile_and_Less_Keyboard_Banging_in_Shell
   [4]: https://bitbucket.org/offline/django-annoying/wiki/Home
   [5]: https://bitbucket.org/siberiano/fastdev-django/wiki/Home.ru
+  [6]: http://nodejs.org/
+  [7]: http://npmjs.org/
 Склонируйте проект:
 
     hg clone https://hg.bitbucket.org/siberiano/fastdev-django
-    
-Если проект будет жить самостоятельно, удалите связь с репозиторием fastdev:
-
     rm yourproject/.hg/hgrc
 
-Если вы хотите участовать в проекте fastdjango, не делайте этого.
+Если вам нужен **CoffeeScript**, прочтите параграф "CoffeeScript" ниже.
 
 Использование
 =====
 
         .footer
             - trans 'Пока'
- 
+
  - **Django Compressor и Sass**
 
 Compressor — модуль для сжатия на лету CSS и ЯваСкрипта из страниц. Здесь он
 теги `script` в странице, открыть файлы скриптов, уплотнить их и сжать в один
 файл.
 
+ - **CoffeeScript**
+
+Если вы хотите использовать CoffeeScript, сделайте следующее:
+
+ - откройте Makefile и раскомментируйте строку `run: bin/coffee`
+ - установите `USE_COFFEE_SCRIPT = True` в файле settings.py
+ - если у вас ОС Ubuntu, проверьте, что установлена программа curl (по
+ умолчанию её нет):
+
+    sudo apt-get install curl
+
+Вам **НЕ НУЖНЫ** ни [Node.js][6], ни [npm][7], чтобы проект запустил
+CoffeeScript. Программа Buildout установит их автоматически. Это удобно,
+когда нужно развернуть проект на хостинге.
+
  - **Webfaction**
 
 Чтобы запустить ваш проект на хостинге Webfaction, нужно сделать специальный
   [2]: http://aatiis.me/
   [3]: https://bitbucket.org/siberiano/fastdev-django/wiki/Makefile_and_Less_Keyboard_Banging_in_Shell
   [4]: https://bitbucket.org/offline/django-annoying/wiki/Home
+  [5]: https://bitbucket.org/siberiano/fastdev-django/wiki/Home.ru
+  [6]: http://nodejs.org/
+  [7]: http://npmjs.org/