www.aleph1.co.uk Git - yaffs-website/blob - node_modules/node-sass/src/libsass/Readme.md

   1 LibSass
   2 =======
   3
   4 by Aaron Leung ([@akhleung]), Hampton Catlin ([@hcatlin]), Marcel Greter ([@mgreter]) and Michael Mifsud ([@xzyfer])
   5
   6 [![Unix CI](https://travis-ci.org/sass/libsass.svg?branch=master)](https://travis-ci.org/sass/libsass)
   7 [![Windows CI](https://ci.appveyor.com/api/projects/status/github/sass/libsass?svg=true)](https://ci.appveyor.com/project/sass/libsass/branch/master)
   8 [![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=283068)](https://www.bountysource.com/trackers/283068-libsass?utm_source=283068&utm_medium=shield&utm_campaign=TRACKER_BADGE)
   9 [![Coverage Status](https://img.shields.io/coveralls/sass/libsass.svg)](https://coveralls.io/r/sass/libsass?branch=feature%2Ftest-travis-ci-3)
  10 [![Join us](https://libsass-slack.herokuapp.com/badge.svg)](https://libsass-slack.herokuapp.com/)
  11
  12 https://github.com/sass/libsass
  13
  14 LibSass is just a library, but if you want to RUN LibSass,
  15 then go to https://github.com/sass/sassc or
  16 https://github.com/sass/sassc-ruby or
  17 [find your local implementer](docs/implementations.md).
  18
  19 LibSass requires GCC 4.6+ or Clang/LLVM. If your OS is older, this version may not compile.
  20
  21 On Windows, you need MinGW with GCC 4.6+ or VS 2013 Update 4+. It is also possible to build LibSass with Clang/LLVM on Windows.
  22
  23 About
  24 -----
  25
  26 LibSass is a C/C++ port of the Sass CSS precompiler. The original version was written in Ruby, but this version is meant for efficiency and portability.
  27
  28 This library strives to be light, simple, and easy to build and integrate with a variety of platforms and languages.
  29
  30 Developing
  31 ----------
  32
  33 As you may have noticed, the LibSass repo itself has
  34 no executables and no tests. Oh noes! How can you develop???
  35
  36 Well, luckily, [SassC](http://github.com/sass/sassc) is the official binary wrapper for
  37 LibSass and is *always* kept in sync. SassC is used by continous integration systems in
  38 LibSass repository. When developing LibSass, it is best to actually
  39 checkout SassC and develop in that directory with the SassC spec
  40 and tests there.
  41
  42 We even run Travis tests for SassC!
  43
  44 Tests
  45 -------
  46
  47 Since LibSass is a pure library, tests are run through the [SassSpec](https://github.com/sass/sass-spec) project using the [SassC](http://github.com/sass/sassc) driver.
  48
  49 To run tests against LibSass while developing, you can run `./script/spec`. This will clone SassC and Sass-Spec under the project folder and then run the Sass-Spec test suite. You may want to update the clones to ensure you have the latest version.
  50
  51 ### DEBUG builds
  52
  53 Set the environment variable `DEBUG` to `1` to enable debug builds that can be debugged
  54 with `gdb`, `lldb` and others. E.g.: use `$ DEBUG=1 ./script/spec` to run the tests with
  55 a debug build.
  56
  57 Library Usage
  58 -------------
  59
  60 While LibSass is a library primarily written in C++, it provides a simple
  61 C interface which should be used by most implementers. LibSass does not do
  62 much on its own without an implementer. This can be a command line tool, like
  63 [sassc](https://github.com/sass/sassc) or a [binding](docs/implementations.md)
  64 to your favorite programing language.
  65
  66 If you want to build or interface with LibSass, we recommend to check out the
  67 documentation pages about [building LibSass](docs/build.md) and
  68 the [C-API documentation](docs/api-doc.md).
  69
  70 About Sass
  71 ----------
  72
  73 Sass is a CSS pre-processor language to add on exciting, new,
  74 awesome features to CSS. Sass was the first language of its kind
  75 and by far the most mature and up to date codebase.
  76
  77 Sass was originally concieved of by the co-creator of this library,
  78 Hampton Catlin ([@hcatlin]). Most of the language has been the result of years
  79 of work by Natalie Weizenbaum ([@nex3]) and Chris Eppstein ([@chriseppstein]).
  80
  81 For more information about Sass itself, please visit http://sass-lang.com
  82
  83 Initial development of libsass by Aaron Leung and Hampton Catlin was supported by [Moovweb](http://www.moovweb.com).
  84
  85 Licensing
  86 ---------
  87
  88 Our MIT license is designed to be as simple, and liberal as possible.
  89
  90 sass2scss was originally written by [Marcel Greter][@mgreter]
  91 and he happily agreed to have it merged into the project.
  92
  93
  94 [@hcatlin]: https://github.com/hcatlin
  95 [@akhleung]: https://github.com/akhleung
  96 [@chriseppstein]: https://github.com/chriseppstein
  97 [@nex3]: https://github.com/nex3
  98 [@mgreter]: https://github.com/mgreter
  99 [@xzyfer]: https://github.com/xzyfer