Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Updated docs for bbb script #98

Closed
wants to merge 1 commit into from

2 participants

@huyz

No description provided.

@tbranyen
Owner

Hey man thanks for this, but could you open this on https://github.com/backbone-boilerplate/core instead.

@huyz

I'm confused. What's the difference?

@tbranyen
Owner

As of recently this is a generated repo. I'll be making that more obvious soon.

@huyz

Couldn't pick a less generic name than core? ;-)

@tbranyen
Owner

Open to suggestions!

@tbranyen tbranyen closed this
@huyz

how about backbone-boilerplate-core, so I can know what it is when I look at my list of repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Apr 8, 2012
  1. @huyz
This page is out of date. Refresh to see the latest.
Showing with 26 additions and 35 deletions.
  1. +26 −35 app/templates/example.html
View
61 app/templates/example.html
@@ -23,7 +23,6 @@ <h2 class="congrats">Congratulations!</h2>
<ul class="nested">
<li><a data-bypass href="#git-history">Removing the Git history</a>
<li><a data-bypass href="#test-dir">Removing the test directory</a>
- <li><a data-bypass href="#build-process">Removing the build process</a>
<li><a data-bypass href="#favicon">Changing the Favicon</a>
<li><a data-bypass href="#app-code">Removing default application code</a>
<li><a data-bypass href="#default-routes">Removing the default routes</a>
@@ -80,7 +79,7 @@ <h2 id="getting-help">Getting help</h2>
you may find help in one of these places:</p>
<ul>
- <li>IRC - #documentcloud on irc.freenode.net
+ <li>IRC - #backbone-boilerplate on irc.freenode.net
<li><a target="blank" href="http://github.com/tbranyen/backbone-boilerplate/issues">GitHub Issues</a> - Please report if you've found an issue,
bug, or controversial request.
</ul>
@@ -114,25 +113,6 @@ <h3 id="cleaning">Cleaning out default files and code</h3>
<li><h4 id="test-dir">Removing the test directory</h4>
<p>If you are not planning on testing your application with QUnit you should delete this directory.</p>
- <li><h4 id="build-process">Removing the build process</h4>
- <p>If you are not planning on using the provided build tool, delete the <code>build</code> folder. It contains a lot of unnecessary code and
- Node.js modules that you will not need. You should also clear out the commented out script tags inside of <code>index.html</code>:
-
- <pre><code>
- &lt;!--
- If using the build tool you can uncomment the following lines and use
- these instead. They will toggle based on if you are using debug or
- release.
- --&gt;
-
- &lt;!--
- &lt;script src=&quot;/assets/js/libs.js&quot;&gt;&lt;/script&gt;
- &lt;script src=&quot;/assets/js/templates.js&quot;&gt;&lt;/script&gt;
- &lt;script src=&quot;/assets/js/app.js&quot;&gt;&lt;/script&gt;
- --&gt;
- </code></pre>
- </p>
-
<li><h4 id="favicon">Changing the Favicon</h4>
<p>At the root level of the project simply change the <code>favicon.ico</code> file to point to your own branded icon.</p>
@@ -184,7 +164,11 @@ <h3 id="cleaning">Cleaning out default files and code</h3>
<h3 id="namespace">Setting your namespace</h3>
<p>This is a very important starting step to creating your application. This brands the application to your name and makes
- it something identifiable to new developers. To set your own namespace, simply open the <code>app/namespace.js</code> file and
+ it something identifiable to new developers.
+ </p>
+
+ <p>If you set up Backbone Boilerplate by running `bbb init`, then you should have already been prompted for a namespace.
+ Otherwise, to set your own namespace, simply open the <code>app/namespace.js</code> file and
make the following modifications:
First change the name of the namespace, this is defined on <code>Line 4</code>
@@ -320,18 +304,30 @@ <h3 id="running">Running with the defaults</h3>
and *not from inside the build folder*.
<pre><code>
- node build
+ bbb
</code></pre>
</p>
<p>
This will do a number of things for you. First it will concatenate all your
libs, app code, and templates into separate files inside the `dist/debug`
- folder. It will then minify those files and your CSS into production ready
+ folder.
+ </p>
+
+ <p>
+ If you instead run
+
+ <pre><code>
+ bbb release
+ </code></pre>
+ </p>
+
+ <p>
+ the build tool will then minify those files and your CSS into production ready
files inside the <code>dist/release</code> folder.</p>
<h3 id="customizing">Customizing the build configuration</h3>
- <p>To customize and configure the build tool, open `build/config.js` and tweak
+ <p>To customize and configure the build tool, open `grunt.js` and tweak
the settings.</p>
<h3 id="server">Using the development server</h3>
@@ -340,7 +336,7 @@ <h3 id="server">Using the development server</h3>
following command to run a server that will always resolve to the <code>index.html</code>
<pre><code>
- node build/server
+ bbb server
</code></pre>
</p>
@@ -358,22 +354,17 @@ <h3 id="server">Using the development server</h3>
or <b>release</b> after the server command, like so:
<pre><code>
- node build/server release
+ bbb server:release
</code></pre>
</p>
<h3 id="adding-tasks">Adding new tasks</h3>
- <p>To add a new task into the build system, you simply copy and paste the task JavaScript folder/file into the <code>build/tasks</code> folder
- or extract the task archive into the same directory. At the very least in order to run this task, you'll need to add it to the <code>build/config.js</code>
- file. The last line should look something like:
+ <p>To add a new task into the build system, you'll need to add it to the <code>grunt.js</code>
+ file. The first `registertask` line should look something like:
<pre><code>
- task.registerTask("default", "clean lint:files concat jst min mincss new_module_here");
+ grunt.registerTask("default", "clean lint jst requirejs concat new_module_here");
</code></pre>
- </p>
-
- It's possible the custom task will have additional setup instructions, so make
- sure you read the README for any task.</p>
</section>
<section id="useful-resources">
Something went wrong with that request. Please try again.