|
1 | | -LibSass - Sass compiler written in C++ |
2 | | -====================================== |
| 1 | +Welcome to the LibSass documentation! |
3 | 2 |
|
4 | | -Currently maintained by Marcel Greter ([@mgreter]) and Michael Mifsud ([@xzyfer]) |
5 | | -Originally created by Aaron Leung ([@akhleung]) and Hampton Catlin ([@hcatlin]) |
| 3 | +## First Off |
| 4 | +LibSass is just a library. To run the code locally (i.e. to compile your stylesheets), you need an implementer. SassC (get it?) is an implementer written in C. There are a number of other implementations of LibSass - for example Node. We encourage you to write your own port - the whole point of LibSass is that we want to bring Sass to many other languages, not just Ruby! |
6 | 5 |
|
7 | | -[](https://travis-ci.org/sass/libsass "Travis CI") |
8 | | -[](https://ci.appveyor.com/project/sass/libsass/branch/master "Appveyor CI") |
9 | | -[](https://coveralls.io/r/sass/libsass?branch=feature%2Ftest-travis-ci-3 "Code coverage of spec tests") |
10 | | -[](http://isitmaintained.com/project/sass/libsass "Percentage of issues still open") |
11 | | -[](http://isitmaintained.com/project/sass/libsass "Average time to resolve an issue") |
12 | | -[](https://www.bountysource.com/trackers/283068-libsass?utm_source=283068&utm_medium=shield&utm_campaign=TRACKER_BADGE "Bountysource") |
13 | | -[](https://libsass-slack.herokuapp.com/ "Slack communication channels") |
| 6 | +We're working hard on moving to full parity with Ruby Sass... learn more at the [The-LibSass-Compatibility-Plan](compatibility-plan.md)! |
14 | 7 |
|
| 8 | +### Implementing LibSass |
15 | 9 |
|
16 | | -[LibSass](https://github.com/sass/libsass "LibSass GitHub Project") is just a library! |
17 | | -If you want to use LibSass to compile Sass, you need an implementer. Some |
18 | | -implementations are only bindings into other programming languages. But most also |
19 | | -ship with a command line interface (CLI) you can use directly. There is also |
20 | | -[SassC](https://github.com/sass/sassc), which is the official lightweight |
21 | | -CLI tool built by the same people as LibSass. |
| 10 | +If you're interested in implementing LibSass in your own project see the [API Documentation](api-doc.md) which now includes implementing |
| 11 | +your own [Sass functions](api-function.md). You may wish to [look at other implementations](implementations.md) for your language of choice. |
| 12 | +Or make your own! |
22 | 13 |
|
23 | | -### Excerpt of "sanctioned" implementations: |
| 14 | +### Contributing to LibSass |
24 | 15 |
|
25 | | -- https://github.com/sass/node-sass (Node.js) |
26 | | -- https://github.com/sass/perl-libsass (Perl) |
27 | | -- https://github.com/sass/libsass-python (Python) |
28 | | -- https://github.com/wellington/go-libsass (Go) |
29 | | -- https://github.com/sass/sassc-ruby (Ruby) |
30 | | -- https://github.com/sass/libsass-net (C#) |
31 | | -- https://github.com/medialize/sass.js (JS) |
32 | | -- https://github.com/bit3/jsass (Java) |
| 16 | +| Issue Tracker | Issue Triage | Community Guidelines | |
| 17 | +|-------------------|----------------------------------|-----------------------------| |
| 18 | +| We're always needing help, so check out our issue tracker, help some people out, and read our article on [Contributing](contributing.md)! It's got all the details on what to do! | To help understand the process of triaging bugs, have a look at our [Issue-Triage](triage.md) document. | Oh, and don't forget we always follow [[Sass Community Guidelines|http://sass-lang.com/community-guidelines]]. Be nice and everyone else will be nice too! | |
33 | 19 |
|
34 | | -This list does not say anything about the quality of either the listed or not listed [implementations](docs/implementations.md)! |
35 | | -The authors of the listed projects above are just known to work regularly together with LibSass developers. |
36 | | - |
37 | | -About |
38 | | ------ |
39 | | - |
40 | | -LibSass is a C++ port of the original Ruby Sass CSS compiler with a [C API](docs/api-doc.md). |
41 | | -We coded LibSass with portability and efficiency in mind. You can expect LibSass to be a lot |
42 | | -faster than Ruby Sass and on par or faster than the best alternative CSS compilers around. |
43 | | - |
44 | | -Developing |
45 | | ----------- |
46 | | - |
47 | | -As noted above, the LibSass repository does not contain any binaries or other way to execute |
48 | | -LibSass. Therefore, you need an implementer to develop LibSass. Easiest is to start with |
49 | | -the official [SassC](http://github.com/sass/sassc) CLI wrapper. It is *guaranteed* to compile |
50 | | -with the latest code in LibSass master, since it is also used in the CI process. There is no |
51 | | -limitation here, as you may use any other LibSass implementer to test your LibSass branch! |
52 | | - |
53 | | -Testing |
54 | | -------- |
55 | | - |
56 | | -Since LibSass is a pure library, tests are run through the [Sass-Spec](https://github.com/sass/sass-spec) |
57 | | -project using the [SassC](http://github.com/sass/sassc) CLI wrapper. To run the tests against LibSass while |
58 | | -developing, you can run `./script/spec`. This will clone SassC and Sass-Spec under the project folder and |
59 | | -then run the Sass-Spec test suite. You may want to update the clones to ensure you have the latest version. |
60 | | -Note that the scripts in the `./script` folder are mainly intended for our CI needs. |
61 | | - |
62 | | -Building |
63 | | --------- |
64 | | - |
65 | | -To build LibSass you need GCC 4.6+ or Clang/LLVM. If your OS is older, you may need to upgrade |
66 | | -them first (or install clang as an alternative). On Windows, you need MinGW with GCC 4.6+ or VS 2013 |
67 | | -Update 4+. It is also possible to build LibSass with Clang/LLVM on Windows with various build chains |
68 | | -and/or command line interpreters. |
69 | | - |
70 | | -See the [build docs for further instructions](docs/build.md)! |
71 | | - |
72 | | -Compatibility |
73 | | -------------- |
74 | | - |
75 | | -Current LibSass 3.4 should be compatible with Sass 3.4. Please refer to the [sass compatibility |
76 | | -page](http://sass-compatibility.github.io/) for a more detailed comparison. But note that there |
77 | | -are still a few incomplete edges which we are aware of. Otherwise LibSass has reached a good level |
78 | | -of stability, thanks to our ever growing [Sass-Spec test suite](https://github.com/sass/sass-spec). |
79 | | - |
80 | | -About Sass |
81 | | ----------- |
82 | | - |
83 | | -Sass is a CSS pre-processor language to add on exciting, new, awesome features to CSS. Sass was |
84 | | -the first language of its kind and by far the most mature and up to date codebase. |
85 | | - |
86 | | -Sass was originally conceived of by the co-creator of this library, Hampton Catlin ([@hcatlin]). |
87 | | -Most of the language has been the result of years of work by Natalie Weizenbaum ([@nex3]) and |
88 | | -Chris Eppstein ([@chriseppstein]). |
89 | | - |
90 | | -For more information about Sass itself, please visit http://sass-lang.com |
91 | | - |
92 | | -Initial development of LibSass by Aaron Leung and Hampton Catlin was supported by [Moovweb](http://www.moovweb.com). |
93 | | - |
94 | | -Licensing |
95 | | ---------- |
96 | | - |
97 | | -Our [MIT license](LICENSE) is designed to be as simple and liberal as possible. |
98 | | - |
99 | | -[@hcatlin]: https://github.com/hcatlin |
100 | | -[@akhleung]: https://github.com/akhleung |
101 | | -[@chriseppstein]: https://github.com/chriseppstein |
102 | | -[@nex3]: https://github.com/nex3 |
103 | | -[@mgreter]: https://github.com/mgreter |
104 | | -[@xzyfer]: https://github.com/xzyfer |
| 20 | +Please refer to the steps on [Building LibSass](build.md) |
0 commit comments