Commit c0c4cd92 authored by JC Brand's avatar JC Brand

Rename builds directory to dist

To conform with how many other projects name their directories.
parent 9f9b38f8
...@@ -43,14 +43,14 @@ develop-eggs ...@@ -43,14 +43,14 @@ develop-eggs
.DS_Store .DS_Store
# Builds # Builds
builds/converse-no-dependencies.min.js dist/converse-no-dependencies.min.js
builds/converse-no-locales-no-otr.js dist/converse-no-locales-no-otr.js
builds/converse-no-locales-no-otr.min.js dist/converse-no-locales-no-otr.min.js
builds/converse-no-otr.js dist/converse-no-otr.js
builds/converse-no-otr.min.js dist/converse-no-otr.min.js
builds/converse.min.js dist/converse.min.js
builds/converse.nojquery.js dist/converse.nojquery.js
builds/converse.nojquery.min.js dist/converse.nojquery.min.js
css/converse.css.map css/converse.css.map
......
...@@ -15,7 +15,7 @@ module.exports = function(grunt) { ...@@ -15,7 +15,7 @@ module.exports = function(grunt) {
} }
}, },
files: { files: {
"builds/templates.js": ["src/templates/*.html"] "dist/templates.js": ["src/templates/*.html"]
}, },
} }
}, },
...@@ -43,7 +43,7 @@ module.exports = function(grunt) { ...@@ -43,7 +43,7 @@ module.exports = function(grunt) {
} }
}, },
src: ['locale/**/LC_MESSAGES/*.json'], src: ['locale/**/LC_MESSAGES/*.json'],
dest: 'builds/locales.js' dest: 'dist/locales.js'
} }
} }
}); });
......
...@@ -134,25 +134,25 @@ css/converse.css:: stamp-bundler stamp-bower sass ...@@ -134,25 +134,25 @@ css/converse.css:: stamp-bundler stamp-bower sass
watch: stamp-bundler watch: stamp-bundler
$(SASS) --watch -I ./components/bourbon/app/assets/stylesheets/ sass/converse.scss:css/converse.css $(SASS) --watch -I ./components/bourbon/app/assets/stylesheets/ sass/converse.scss:css/converse.css
BUILDS = builds/converse.js \ BUILDS = dist/converse.js \
builds/converse.min.js \ dist/converse.min.js \
builds/converse.nojquery.js \ dist/converse.nojquery.js \
builds/converse.nojquery.min.js \ dist/converse.nojquery.min.js \
builds/converse-no-dependencies.min.js \ dist/converse-no-dependencies.min.js \
builds/converse-no-dependencies.js dist/converse-no-dependencies.js
builds/converse.min.js: stamp-bower src locale components *.js dist/converse.min.js: stamp-bower src locale components *.js
$(RJS) -o src/build.js $(RJS) -o src/build.js
builds/converse.js: stamp-bower src locale components *.js dist/converse.js: stamp-bower src locale components *.js
$(RJS) -o src/build.js optimize=none out=builds/converse.js $(RJS) -o src/build.js optimize=none out=dist/converse.js
builds/converse.nojquery.min.js: stamp-bower src locale components *.js dist/converse.nojquery.min.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-jquery.js $(RJS) -o src/build-no-jquery.js
builds/converse.nojquery.js: stamp-bower src locale components *.js dist/converse.nojquery.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-jquery.js optimize=none out=builds/converse.nojquery.js $(RJS) -o src/build-no-jquery.js optimize=none out=dist/converse.nojquery.js
builds/converse-no-dependencies.min.js: stamp-bower src locale components *.js dist/converse-no-dependencies.min.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-dependencies.js $(RJS) -o src/build-no-dependencies.js
builds/converse-no-dependencies.js: stamp-bower src locale components *.js dist/converse-no-dependencies.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=builds/converse-no-dependencies.js $(RJS) -o src/build-no-dependencies.js optimize=none out=dist/converse-no-dependencies.js
.PHONY: jsmin .PHONY: jsmin
jsmin: $(BUILDS) jsmin: $(BUILDS)
...@@ -161,10 +161,8 @@ jsmin: $(BUILDS) ...@@ -161,10 +161,8 @@ jsmin: $(BUILDS)
cssmin: stamp-npm cssmin: stamp-npm
$(GRUNT) cssmin $(GRUNT) cssmin
.PHONY: converse .PHONY: dist
converse:: stamp-npm dist:: build
$(RJS) -o src/build-no-dependencies.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=builds/converse-no-dependencies.js
.PHONY: build .PHONY: build
build:: stamp-npm build:: stamp-npm
......
...@@ -57,11 +57,11 @@ build:: stamp-npm ...@@ -57,11 +57,11 @@ build:: stamp-npm
$(GRUNT) jst $(GRUNT) jst
$(GRUNT) cssmin $(GRUNT) cssmin
$(RJS) -o src/build.js $(RJS) -o src/build.js
$(RJS) -o src/build.js optimize=none out=builds/converse.js $(RJS) -o src/build.js optimize=none out=dist/converse.js
$(RJS) -o src/build-no-jquery.js $(RJS) -o src/build-no-jquery.js
$(RJS) -o src/build-no-jquery.js optimize=none out=builds/converse.nojquery.js $(RJS) -o src/build-no-jquery.js optimize=none out=dist/converse.nojquery.js
$(RJS) -o src/build-no-dependencies.js $(RJS) -o src/build-no-dependencies.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=builds/converse-no-dependencies.js $(RJS) -o src/build-no-dependencies.js optimize=none out=dist/converse-no-dependencies.js
######################################################################## ########################################################################
## Tests ## Tests
......
This diff is collapsed.
...@@ -20,16 +20,16 @@ Creating builds ...@@ -20,16 +20,16 @@ Creating builds
.. note:: Please make sure to read the section :doc:`development` and that you have installed .. 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``) all development dependencies (long story short, you should be able to just run ``make dev``)
Creating builds Creating builds and distribution files
=============== ======================================
We use `require.js <http://requirejs.org>`_ to keep track of *Converse.js* and We use `require.js <http://requirejs.org>`_ to keep track of *Converse.js* and
its dependencies and to to bundle them together in a single file fit for its dependencies and to to bundle them together in a single file fit for
deployment to a production site. deployment to a production site.
To create the bundles, simply run:: To create the distributable bundles, simply run::
make build make dist
This command does the following: This command does the following:
...@@ -46,15 +46,15 @@ This command does the following: ...@@ -46,15 +46,15 @@ This command does the following:
* Also, the CSS files in the ``./css`` directory will be minified. * Also, the CSS files in the ``./css`` directory will be minified.
The built Javasript bundles are contained in the ``./builds`` directory: The built Javasript bundles are contained in the ``./dist`` directory:
.. code-block:: bash .. code-block:: bash
jc@conversejs:~/converse.js (master)$ ls builds/ jc@conversejs:~/converse.js (master)$ ls dist/
converse.js converse-no-locales-no-otr.js converse.website.min.js converse.js converse-no-dependencies.js
converse.min.js converse-no-locales-no-otr.min.js converse.website-no-otr.min.js converse.min.js converse-no-dependencies.min.js
converse.nojquery.js converse-no-otr.js locales.js converse.nojquery.js locales.js
converse.nojquery.min.js converse-no-otr.min.js templates.js converse.nojquery.min.js templates.js
.. _`minification`: .. _`minification`:
......
...@@ -8,19 +8,25 @@ Quickstart (to get a demo up and running) ...@@ -8,19 +8,25 @@ Quickstart (to get a demo up and running)
When you download a specific release of *Converse.js* there will be two minified files inside the zip file. When you download a specific release of *Converse.js* there will be two minified files inside the zip file.
* builds/converse.min.js * dist/converse.js
* css/converse.min.css * css/converse.min.css
You can include these two files inside the *<head>* element of your website via the *script* and *link* You can include these two files inside the *<head>* element of your website via the *script* and *link* tags:
tags:
.. code-block:: html .. code-block:: html
<link rel="stylesheet" type="text/css" media="screen" href="css/converse.min.css"> <link rel="stylesheet" type="text/css" media="screen" href="css/converse.min.css">
<script src="builds/converse.min.js"></script> <script src="dist/converse.js"></script>
You need to initialize Converse.js with configuration settings according to .. note::
your requirements. Note that the Javascript file ``converse.js`` contains **all** the dependencies
of converse.js and is unminified, so it's very large. Before you host
converse.js yourself, you'll definitely want to generate a minified version
first. There are various ways to do this. One option is to simply run ``make dist``,
in your converse.js repo checkout. A minified file ``dist/converse.min.js`` will
then be created for you, which you can use.
You need to initialize Converse.js with configuration settings according to your requirements.
Please refer to the :ref:`configuration-variables` section for info on all the available configuration settings. Please refer to the :ref:`configuration-variables` section for info on all the available configuration settings.
......
...@@ -65,11 +65,11 @@ To generate the CSS you can run:: ...@@ -65,11 +65,11 @@ To generate the CSS you can run::
make css make css
Creating builds Creating dist files
=============== ===================
Once you've themed converse.js, you'll want to create new minified builds of Once you've themed converse.js, you'll want to create new minified distribution
the Javascript and CSS files. files of all the Javascript and CSS.
Please refer to the :doc:`builds` section for information on how this is done. Please refer to the :doc:`builds` section for information on how this is done.
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
<script type="text/javascript" src="analytics.js"></script> <script type="text/javascript" src="analytics.js"></script>
<noscript><p><img src="//stats.opkode.com/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript> <noscript><p><img src="//stats.opkode.com/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<![if gte IE 9]> <![if gte IE 9]>
<script src="builds/converse.js"></script> <script src="dist/converse.js"></script>
<![endif]> <![endif]>
</head> </head>
......
...@@ -53,12 +53,18 @@ ...@@ -53,12 +53,18 @@
<!-- END BACKBONE --> <!-- END BACKBONE -->
<!-- BEGIN I18N --> <!-- BEGIN I18N -->
<!-- These files can be removed if you don't want to include any
translations for converse.js.
If you want to modify which translations are included, you can modify
src/locales.js to remove those you don't need, and then run `make
build` to generates a new dist/locales.js file.
-->
<script type="text/javascript" src="components/jed/jed.js"></script> <script type="text/javascript" src="components/jed/jed.js"></script>
<script type="text/javascript" src="builds/locales.js"></script> <script type="text/javascript" src="dist/locales.js"></script>
<!-- END I18N --> <!-- END I18N -->
<script type="text/javascript" src="components/momentjs/min/moment-with-locales.js"></script> <script type="text/javascript" src="components/momentjs/min/moment-with-locales.js"></script>
<script type="text/javascript" src="builds/converse-no-dependencies.js"></script> <script type="text/javascript" src="dist/converse-no-dependencies.js"></script>
</head> </head>
<body id="page-top" data-spy="scroll" data-target=".navbar-custom"> <body id="page-top" data-spy="scroll" data-target=".navbar-custom">
<section class="intro"> <section class="intro">
......
({ ({
baseUrl: "../", baseUrl: "../",
name: "components/almond/almond.js", name: "components/almond/almond.js",
out: "../builds/converse-no-dependencies.min.js", out: "../dist/converse-no-dependencies.min.js",
include: ['converse'], include: ['converse'],
excludeShallow: [ excludeShallow: [
'locales', 'locales',
......
({ ({
baseUrl: "../", baseUrl: "../",
name: "components/almond/almond.js", name: "components/almond/almond.js",
out: "../builds/converse.nojquery.min.js", out: "../dist/converse.nojquery.min.js",
include: ['converse'], include: ['converse'],
exclude: ['jquery', 'jquery-private'], exclude: ['jquery', 'jquery-private'],
insertRequire: ['converse'], insertRequire: ['converse'],
......
({ ({
baseUrl: "../", baseUrl: "../",
name: "components/almond/almond.js", name: "components/almond/almond.js",
out: "../builds/converse.min.js", out: "../dist/converse.min.js",
mainConfigFile: '../main.js', mainConfigFile: '../main.js',
include: ['converse'], include: ['converse'],
insertRequire: ['converse'] insertRequire: ['converse']
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment