This repository has been archived by the owner on Jul 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This reverts commit 8004d10.
- Loading branch information
Showing
58 changed files
with
146 additions
and
19,561 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,104 @@ | ||
| Welcome to the LibSass documentation! | ||
| LibSass - Sass compiler written in C++ | ||
| ====================================== | ||
|
|
||
| ## First Off | ||
| 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! | ||
| Currently maintained by Marcel Greter ([@mgreter]) and Michael Mifsud ([@xzyfer]) | ||
| Originally created by Aaron Leung ([@akhleung]) and Hampton Catlin ([@hcatlin]) | ||
|
|
||
| We're working hard on moving to full parity with Ruby Sass... learn more at the [The-LibSass-Compatibility-Plan](compatibility-plan.md)! | ||
| [](https://travis-ci.org/sass/libsass "Travis CI") | ||
| [](https://ci.appveyor.com/project/sass/libsass/branch/master "Appveyor CI") | ||
| [](https://coveralls.io/r/sass/libsass?branch=feature%2Ftest-travis-ci-3 "Code coverage of spec tests") | ||
| [](http://isitmaintained.com/project/sass/libsass "Percentage of issues still open") | ||
| [](http://isitmaintained.com/project/sass/libsass "Average time to resolve an issue") | ||
| [](https://www.bountysource.com/trackers/283068-libsass?utm_source=283068&utm_medium=shield&utm_campaign=TRACKER_BADGE "Bountysource") | ||
| [](https://libsass-slack.herokuapp.com/ "Slack communication channels") | ||
|
|
||
| ### Implementing LibSass | ||
|
|
||
| If you're interested in implementing LibSass in your own project see the [API Documentation](api-doc.md) which now includes implementing | ||
| your own [Sass functions](api-function.md). You may wish to [look at other implementations](implementations.md) for your language of choice. | ||
| Or make your own! | ||
| [LibSass](https://github.com/sass/libsass "LibSass GitHub Project") is just a library! | ||
| If you want to use LibSass to compile Sass, you need an implementer. Some | ||
| implementations are only bindings into other programming languages. But most also | ||
| ship with a command line interface (CLI) you can use directly. There is also | ||
| [SassC](https://github.com/sass/sassc), which is the official lightweight | ||
| CLI tool built by the same people as LibSass. | ||
|
|
||
| ### Contributing to LibSass | ||
| ### Excerpt of "sanctioned" implementations: | ||
|
|
||
| | Issue Tracker | Issue Triage | Community Guidelines | | ||
| |-------------------|----------------------------------|-----------------------------| | ||
| | 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! | | ||
| - https://github.com/sass/node-sass (Node.js) | ||
| - https://github.com/sass/perl-libsass (Perl) | ||
| - https://github.com/sass/libsass-python (Python) | ||
| - https://github.com/wellington/go-libsass (Go) | ||
| - https://github.com/sass/sassc-ruby (Ruby) | ||
| - https://github.com/sass/libsass-net (C#) | ||
| - https://github.com/medialize/sass.js (JS) | ||
| - https://github.com/bit3/jsass (Java) | ||
|
|
||
| Please refer to the steps on [Building LibSass](build.md) | ||
| This list does not say anything about the quality of either the listed or not listed [implementations](docs/implementations.md)! | ||
| The authors of the listed projects above are just known to work regularly together with LibSass developers. | ||
|
|
||
| About | ||
| ----- | ||
|
|
||
| LibSass is a C++ port of the original Ruby Sass CSS compiler with a [C API](docs/api-doc.md). | ||
| We coded LibSass with portability and efficiency in mind. You can expect LibSass to be a lot | ||
| faster than Ruby Sass and on par or faster than the best alternative CSS compilers around. | ||
|
|
||
| Developing | ||
| ---------- | ||
|
|
||
| As noted above, the LibSass repository does not contain any binaries or other way to execute | ||
| LibSass. Therefore, you need an implementer to develop LibSass. Easiest is to start with | ||
| the official [SassC](http://github.com/sass/sassc) CLI wrapper. It is *guaranteed* to compile | ||
| with the latest code in LibSass master, since it is also used in the CI process. There is no | ||
| limitation here, as you may use any other LibSass implementer to test your LibSass branch! | ||
|
|
||
| Testing | ||
| ------- | ||
|
|
||
| Since LibSass is a pure library, tests are run through the [Sass-Spec](https://github.com/sass/sass-spec) | ||
| project using the [SassC](http://github.com/sass/sassc) CLI wrapper. To run the 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. | ||
| Note that the scripts in the `./script` folder are mainly intended for our CI needs. | ||
|
|
||
| Building | ||
| -------- | ||
|
|
||
| To build LibSass you need GCC 4.6+ or Clang/LLVM. If your OS is older, you may need to upgrade | ||
| them first (or install clang as an alternative). 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 with various build chains | ||
| and/or command line interpreters. | ||
|
|
||
| See the [build docs for further instructions](docs/build.md)! | ||
|
|
||
| Compatibility | ||
| ------------- | ||
|
|
||
| Current LibSass 3.4 should be compatible with Sass 3.4. Please refer to the [sass compatibility | ||
| page](http://sass-compatibility.github.io/) for a more detailed comparison. But note that there | ||
| are still a few incomplete edges which we are aware of. Otherwise LibSass has reached a good level | ||
| of stability, thanks to our ever growing [Sass-Spec test suite](https://github.com/sass/sass-spec). | ||
|
|
||
| About Sass | ||
| ---------- | ||
|
|
||
| Sass is a CSS pre-processor language to add on exciting, new, awesome features to CSS. Sass was | ||
| the first language of its kind and by far the most mature and up to date codebase. | ||
|
|
||
| Sass was originally conceived of by the co-creator of this library, Hampton Catlin ([@hcatlin]). | ||
| Most of the language has been the result of years of work by Natalie Weizenbaum ([@nex3]) and | ||
| Chris Eppstein ([@chriseppstein]). | ||
|
|
||
| For more information about Sass itself, please visit http://sass-lang.com | ||
|
|
||
| Initial development of LibSass by Aaron Leung and Hampton Catlin was supported by [Moovweb](http://www.moovweb.com). | ||
|
|
||
| Licensing | ||
| --------- | ||
|
|
||
| Our [MIT license](LICENSE) is designed to be as simple and liberal as possible. | ||
|
|
||
| [@hcatlin]: https://github.com/hcatlin | ||
| [@akhleung]: https://github.com/akhleung | ||
| [@chriseppstein]: https://github.com/chriseppstein | ||
| [@nex3]: https://github.com/nex3 | ||
| [@mgreter]: https://github.com/mgreter | ||
| [@xzyfer]: https://github.com/xzyfer |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.