public/assets/bootstrap-rtl-3-3-4/README.md

   1 # Bootstrap 3 RTL Theme
   2
   3 ---
   4
   5 ***Note: Hopefully, they will add rtl support to the next major release of bootstrap, so this project will be absolete. However, it's going to be updated for the next 3.x releases.***
   6
   7 > Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development.
   8
   9
  10 Bootstrap RTL provides simple yet robust right-to-left capability for Bootstrap 3, by employing new theming feature of it. Simply put its CSS after bootstrap's original CSS, to the pages designed by Bootstrap 3. It works just like an extension on top of the original Bootstrap:
  11
  12 ```html
  13 <!-- Original Bootstrap 3.x -->
  14 <link rel="stylesheet" href="bootstrap.css">
  15
  16 <!-- Bootstrap RTL Theme -->
  17 <link rel="stylesheet" href="bootstrap-rtl.css">
  18 ```
  19
  20 Or load it from CDN:
  21
  22 ```html
  23 <!-- Load Bootstrap RTL theme from CDNJS -->
  24 <link rel="stylesheet" href="//cdn.rawgit.com/morteza/bootstrap-rtl/master/dist/css/bootstrap-rtl.min.css">
  25 ```
  26
  27 ## Quick start
  28
  29 To get started, **[download latest release](https://github.com/morteza/bootstrap-rtl/releases/latest)**. Check `examples/` directory for more. It's just like Bootstrap 3, nothing special. You can also install it via bower:
  30
  31 * Run `bower install bootstrap-rtl` and latest version will be installed under *bower_components/bootstrap-rtl/* directory.
  32
  33 In addition to bootstrap distribution, LESS codes for RTL theme and compiled CSS (`bootstrap-rtl.css`) are provided, as well as minified CSS (`bootstrap-rtl.min.css`). Check `dist/` directory for all the codes you need.
  34
  35 #### Auto Flip (`.flip`)
  36 To automatically flip placements from right to left and vice versa (in bilingual pages), use `.flip` alongside `.pull-right` and `.pull-left`. This is a custom class and is not available in the original Bootstrap 3.
  37
  38 ## Building CSS and JavaScript
  39
  40 Bootstrap RTL uses [Grunt](http://gruntjs.com/) for working with the framework. Follow these simple steps to prepare and compile:
  41
  42 1. Run `npm install` to download and prepare dependencies.
  43 2. Run `grunt`, and check `dist/` directory for outputs.
  44
  45 ## Development
  46
  47 Contributors to Bootstrap RTL must agree the license by signing on the bottom of the `CONTRIBUTORS.md` file. To contribute:
  48
  49 - [fork the bootstrap-rtl repository](https://github.com/morteza/bootstrap-rtl/fork).
  50 - make your changes
  51 - *first time contributors*: Sign `CONTRIBUTORS.md` by adding your github username, full name, email address, and first contribution date. As follows:
  52     `YYYY/MM/DD, Github Username, Full Name, Email Address`
  53 - commit your changes.
  54 - send a pull request.
  55
  56
  57 ***Important Notice:* Before submitting any pull request, please ensure that your changes merge cleanly with the main repository at morteza/bootstrap-rtl.**
  58
  59
  60 ### Feature requests, and bug fixes
  61
  62 If you want a feature or a bug fixed, [report it via project's issues tracker](https://github.com/morteza/bootstrap-rtl/issues). However, if it's something you can fix yourself, *fork* the project, *do* whatever it takes to resolve it, and finally submit a *pull* request. I will personally thank you, and add your name to the list of contributors.
  63
  64 ## Author
  65
  66 **Morteza Ansarinia**
  67
  68 + [http://github.com/morteza](http://github.com/morteza)
  69
  70
  71 ## License
  72
  73 I have no idea what licenses are for exactly. So there is no license control over this bootstrap-rtl project. However bootstrap itself is licensed by Twitter, Inc. under [the MIT License (MIT)](LICENSE.bootstrap).
  74
  75 If it really matters to you to have a license to avoid litigations, this is an unlicensed public domain software. Read [UNLICENSE file](UNLICENSE) for more.
  76
  77
  78