|
| 1 | +Datatracker information |
| 2 | +_______________________ |
| 3 | + |
| 4 | +Content |
| 5 | +======= |
| 6 | + |
| 7 | +The files in this directory are modified versions of bootstrap v3.3.4. This is |
| 8 | +a cumbersome way to customize bootsrap, but as of the time of writing this |
| 9 | +(03 Apr 2015), there seems to be no provision for including modifications |
| 10 | +within the distributed build environment without either editing files in |
| 11 | +place, or copying and modifying parts of the build environment. |
| 12 | + |
| 13 | +Modifications done:: |
| 14 | + |
| 15 | + less/variables.less # modified with our datatracker-specific changes |
| 16 | + |
| 17 | +Setup |
| 18 | +===== |
| 19 | + |
| 20 | +In order to set up things to build new static/css/bootstrap* files, do the |
| 21 | +following (copied from http://getbootstrap.com/getting-started/#grunt) |
| 22 | + |
| 23 | +Bootstrap uses Grunt for its build system, with convenient methods for working |
| 24 | +with the framework. It's how we compile our code, run tests, and more. |
| 25 | + |
| 26 | +Installing Grunt |
| 27 | +---------------- |
| 28 | + |
| 29 | +To install Grunt, you must first download and install node.js (which includes |
| 30 | +npm). npm stands for node packaged modules and is a way to manage development |
| 31 | +dependencies through node.js. |
| 32 | + |
| 33 | +Then, from the command line: Install grunt-cli globally with :: |
| 34 | + |
| 35 | + npm install -g grunt-cli. |
| 36 | + |
| 37 | +Navigate to the root /bootstrap/ directory, then run:: |
| 38 | + |
| 39 | + npm install |
| 40 | + |
| 41 | +npm will look at the package.json file and automatically install the necessary |
| 42 | +local dependencies listed there. |
| 43 | + |
| 44 | +When completed, you'll be able to run the various Grunt commands provided from |
| 45 | +the command line. |
| 46 | + |
| 47 | +Usage |
| 48 | +===== |
| 49 | + |
| 50 | +Available Grunt commands |
| 51 | +------------------------ |
| 52 | + |
| 53 | +:: |
| 54 | + |
| 55 | + grunt dist # (Just compile CSS and JavaScript) |
| 56 | + |
| 57 | +Regenerates the /dist/ directory with compiled and minified CSS and JavaScript |
| 58 | +files. As a Bootstrap user, this is normally the command you want. |
| 59 | + |
| 60 | +:: |
| 61 | + |
| 62 | + grunt watch # (Watch) |
| 63 | + |
| 64 | +Watches the Less source files and automatically recompiles them to CSS |
| 65 | +whenever you save a change. |
| 66 | + |
| 67 | +:: |
| 68 | + |
| 69 | + grunt test (Run tests) |
| 70 | + |
| 71 | +Runs JSHint and runs the QUnit tests headlessly in PhantomJS. |
| 72 | + |
| 73 | +:: |
| 74 | + |
| 75 | + grunt docs # (Build & test the docs assets) |
| 76 | + |
| 77 | +Builds and tests CSS, JavaScript, and other assets which are used when running |
| 78 | +the documentation locally via jekyll serve. |
| 79 | + |
| 80 | +:: |
| 81 | + |
| 82 | + grunt # (Build absolutely everything and run tests) |
| 83 | + |
| 84 | +Compiles and minifies CSS and JavaScript, builds the documentation website, |
| 85 | +runs the HTML5 validator against the docs, regenerates the Customizer assets, |
| 86 | +and more. Requires Jekyll. Usually only necessary if you're hacking on |
| 87 | +Bootstrap itself. |
| 88 | + |
| 89 | + |
0 commit comments