Rename builds directory to dist

To conform with how many other projects name their directories.
This commit is contained in:
JC Brand 2016-02-28 09:00:22 +00:00
parent 9f9b38f852
commit c0c4cd9272
16 changed files with 2264 additions and 2435 deletions

16
.gitignore vendored
View File

@ -43,14 +43,14 @@ develop-eggs
.DS_Store
# Builds
builds/converse-no-dependencies.min.js
builds/converse-no-locales-no-otr.js
builds/converse-no-locales-no-otr.min.js
builds/converse-no-otr.js
builds/converse-no-otr.min.js
builds/converse.min.js
builds/converse.nojquery.js
builds/converse.nojquery.min.js
dist/converse-no-dependencies.min.js
dist/converse-no-locales-no-otr.js
dist/converse-no-locales-no-otr.min.js
dist/converse-no-otr.js
dist/converse-no-otr.min.js
dist/converse.min.js
dist/converse.nojquery.js
dist/converse.nojquery.min.js
css/converse.css.map

View File

@ -15,7 +15,7 @@ module.exports = function(grunt) {
}
},
files: {
"builds/templates.js": ["src/templates/*.html"]
"dist/templates.js": ["src/templates/*.html"]
},
}
},
@ -43,7 +43,7 @@ module.exports = function(grunt) {
}
},
src: ['locale/**/LC_MESSAGES/*.json'],
dest: 'builds/locales.js'
dest: 'dist/locales.js'
}
}
});

View File

@ -134,25 +134,25 @@ css/converse.css:: stamp-bundler stamp-bower sass
watch: stamp-bundler
$(SASS) --watch -I ./components/bourbon/app/assets/stylesheets/ sass/converse.scss:css/converse.css
BUILDS = builds/converse.js \
builds/converse.min.js \
builds/converse.nojquery.js \
builds/converse.nojquery.min.js \
builds/converse-no-dependencies.min.js \
builds/converse-no-dependencies.js
BUILDS = dist/converse.js \
dist/converse.min.js \
dist/converse.nojquery.js \
dist/converse.nojquery.min.js \
dist/converse-no-dependencies.min.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
builds/converse.js: stamp-bower src locale components *.js
$(RJS) -o src/build.js optimize=none out=builds/converse.js
builds/converse.nojquery.min.js: stamp-bower src locale components *.js
dist/converse.js: stamp-bower src locale components *.js
$(RJS) -o src/build.js optimize=none out=dist/converse.js
dist/converse.nojquery.min.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-jquery.js
builds/converse.nojquery.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-jquery.js optimize=none out=builds/converse.nojquery.js
builds/converse-no-dependencies.min.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=dist/converse.nojquery.js
dist/converse-no-dependencies.min.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-dependencies.js
builds/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
dist/converse-no-dependencies.js: stamp-bower src locale components *.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=dist/converse-no-dependencies.js
.PHONY: jsmin
jsmin: $(BUILDS)
@ -161,10 +161,8 @@ jsmin: $(BUILDS)
cssmin: stamp-npm
$(GRUNT) cssmin
.PHONY: converse
converse:: stamp-npm
$(RJS) -o src/build-no-dependencies.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=builds/converse-no-dependencies.js
.PHONY: dist
dist:: build
.PHONY: build
build:: stamp-npm

View File

@ -57,11 +57,11 @@ build:: stamp-npm
$(GRUNT) jst
$(GRUNT) cssmin
$(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 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 optimize=none out=builds/converse-no-dependencies.js
$(RJS) -o src/build-no-dependencies.js optimize=none out=dist/converse-no-dependencies.js
########################################################################
## Tests

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -20,16 +20,16 @@ Creating 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 builds and distribution files
======================================
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
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:
@ -46,15 +46,15 @@ This command does the following:
* 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
jc@conversejs:~/converse.js (master)$ ls builds/
converse.js converse-no-locales-no-otr.js converse.website.min.js
converse.min.js converse-no-locales-no-otr.min.js converse.website-no-otr.min.js
converse.nojquery.js converse-no-otr.js locales.js
converse.nojquery.min.js converse-no-otr.min.js templates.js
jc@conversejs:~/converse.js (master)$ ls dist/
converse.js converse-no-dependencies.js
converse.min.js converse-no-dependencies.min.js
converse.nojquery.js locales.js
converse.nojquery.min.js templates.js
.. _`minification`:

View File

@ -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.
* builds/converse.min.js
* dist/converse.js
* css/converse.min.css
You can include these two files inside the *<head>* element of your website via the *script* and *link*
tags:
You can include these two files inside the *<head>* element of your website via the *script* and *link* tags:
.. code-block:: html
<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
your requirements.
.. note::
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.

View File

@ -65,11 +65,11 @@ To generate the CSS you can run::
make css
Creating builds
===============
Creating dist files
===================
Once you've themed converse.js, you'll want to create new minified builds of
the Javascript and CSS files.
Once you've themed converse.js, you'll want to create new minified distribution
files of all the Javascript and CSS.
Please refer to the :doc:`builds` section for information on how this is done.

View File

@ -16,7 +16,7 @@
<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>
<![if gte IE 9]>
<script src="builds/converse.js"></script>
<script src="dist/converse.js"></script>
<![endif]>
</head>

View File

@ -53,12 +53,18 @@
<!-- END BACKBONE -->
<!-- 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="builds/locales.js"></script>
<script type="text/javascript" src="dist/locales.js"></script>
<!-- END I18N -->
<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>
<body id="page-top" data-spy="scroll" data-target=".navbar-custom">
<section class="intro">

View File

@ -1,7 +1,7 @@
({
baseUrl: "../",
name: "components/almond/almond.js",
out: "../builds/converse-no-dependencies.min.js",
out: "../dist/converse-no-dependencies.min.js",
include: ['converse'],
excludeShallow: [
'locales',

View File

@ -1,7 +1,7 @@
({
baseUrl: "../",
name: "components/almond/almond.js",
out: "../builds/converse.nojquery.min.js",
out: "../dist/converse.nojquery.min.js",
include: ['converse'],
exclude: ['jquery', 'jquery-private'],
insertRequire: ['converse'],

View File

@ -1,7 +1,7 @@
({
baseUrl: "../",
name: "components/almond/almond.js",
out: "../builds/converse.min.js",
out: "../dist/converse.min.js",
mainConfigFile: '../main.js',
include: ['converse'],
insertRequire: ['converse']