소스 검색

Mention creating your own builds in the quickstart guide

JC Brand 7 년 전
부모
커밋
4f72b0999b
2개의 변경된 파일24개의 추가작업 그리고 4개의 파일을 삭제
  1. 3 2
      docs/source/builds.rst
  2. 21 2
      docs/source/quickstart.rst

+ 3 - 2
docs/source/builds.rst

@@ -20,6 +20,8 @@ Generating builds
 .. Note:: Please make sure to read the section :doc:`development` and that you have installed
     all development dependencies (long story short, you should be able to just run  ``make dev``)
 
+.. _creating_builds:
+
 Creating JavaScript and CSS bundles and distribution files
 ==========================================================
 
@@ -43,9 +45,8 @@ to let the bundles be automatically generated as soon as you edit a file.
 The Converse repository does not include the minified files in the ``dist`` or
 ``css`` directories. Before deployment, you'll want to generate them yourself.
 
-To only generate the minified files, you can make them individually.
+To only generate the minified files, you can make them individually. ::
 
-::
     make dist/converse.min.js
     make css/converse.min.css
 

+ 21 - 2
docs/source/quickstart.rst

@@ -9,8 +9,8 @@ Quickstart
 Getting a demo up and running
 =============================
 
-Use the content delivery network
---------------------------------
+Option 1: Use the content delivery network
+------------------------------------------
 
 Converse has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
 which hosts its JavaScript and CSS files.
@@ -42,6 +42,25 @@ via the *script* and *link* tags:
     latest one), to avoid breakage when new backwards-incompatible versions are
     released.
 
+
+Option 2: Building the files yourself
+-------------------------------------
+
+Instead of using the CDN, you can also create your own builds and host them
+yourself.
+
+Have a look at the :ref:`creating_builds` section on how to create your own
+builds.
+
+Long story short, you should be able to do it by running `make dist`, but you
+might need to install some development libraries on your system first
+(e.g. gcc, libffi-dev and ruby-dev).
+
+Besides including the ``converse.min.js`` and ``converse.min.css`` files,
+you'll also need to make sure that the ``webfonts`` directory is available in
+the same location as ``converse.min.css``.
+
+
 Initializing Converse
 ---------------------