BWA: Fix responsive layout for global navbar
[blender-web-assets.git] / README.md
1 # Blender Web Assets
2 Blender Web Assets is a front-end framework which provides design and interactivity components for official [Blender.org websites](http://www.blender.org).
3
4 ## Install and usage
5 ### Software you need
6 * **[git](http://git-scm.com)** To clone and contribute to this repository you need Git. Install from here: http://git-scm.com/downloads.
7 * **[Sass](http://sass-lang.com)** Our CSS preprocessor is SASS. If you don't have it installed, follow the step by step guide on their website: http://sass-lang.com/install.
8 * **[NODE.JS](http://nodejs.org)** We use Node.js to power gulp to run repetitive tasks like prefixing CSS. Make sure, that you have Node.js installed on your system. Download from here: http://nodejs.org/download or install via a package manager: http://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager.
9
10 ### Setup
11 1. Open up your terminal.
12 2. Clone this repository with `git clone git://git.blender.org/blender-web-assets.git`.
13 3. Navigate to this project using `cd /path/to/blender-web-assets`.
14 4. Do `npm install -g gulp` to install gulp globally (you maybe have to run this command as root).
15 5. Run `npm install`
16 6. `gulp` will compile and prefix the Sass. Additionally, `gulp watch` will keep gulping when there are changes in the source files.
17
18 ## Usage
19 Now you can type `gulp` in the terminal every time you need the Sass compiled to `css/main.css`. Open [index.html](index.html) to review your changes.
20
21 ### As a git submodule
22 The whole concept of Blender Web Assets is to be shared between official Blender projects.
23
24 Clone, initalize, and update:
25 1. `git clone git://git.blender.org/blender-web-assets.git`
26 2. `git submodule init`
27 3. `git submodule update --remote`
28
29 Then in each project you can just `import` via Sass the components you need from BWA.
30
31 Each project must have a working gulp pipeline (`package.json` and `gulpfile.js`), most dependencies are covered in BWA's `package.json`.
32
33 ## Demo
34 See BWA in action:
35
36 * [blender.org](https://www.blender.org)
37 * [code.blender.org](https://code.blender.org) (extending the blender.org theme)
38 * [Blender ID](https://id.blender.org)
39 * [Blender Conference](https://www.blender.org/conference)
40 * [Blender Open Data](https://opendata.blender.org/)
41 * [Blender My Data](https://mydata.blender.org/)
42
43
44 ## Authors
45 [Pablo Vazquez](http://developer.blender.org/p/pablovazquez)
46 [Niklas Ravnsborg-Gjertsen](http://developer.blender.org/p/niklasravnsborg)
47
48 ## Copyright and license
49 This project is licensed under [the GPL license](LICENSE) copyright © 2019 Blender Foundation.