1`libsass` is only a library and does not do much on its own. You need an implementation that you can use from the [command line][6]. Or some [bindings|Implementations][9] to use it within your favorite programming language. You should be able to get [`sassc`][6] running by following the instructions in this guide. 2 3Before starting, see [setup dev environment](setup-environment.md). 4 5Building on different Operating Systems 6-- 7 8We try to keep the code as OS independent and standard compliant as possible. Reading files from the file-system has some OS depending code, but will ultimately fall back to a posix compatible implementation. We do use some `C++11` features, but are so far only committed to use `unordered_map`. This means you will need a pretty recent compiler on most systems (gcc 4.5 seems to be the minimum). 9 10### Building on Linux (and other *nix flavors) 11 12Linux is the main target for `libsass` and we support two ways to build `libsass` here. The old plain makefiles should still work on most systems (including MinGW), while the autotools build is preferred if you want to create a [system library] (experimental). 13 14- [Building with makefiles][1] 15- [Building with autotools][2] 16 17### Building on Windows (experimental) 18 19Windows build support was added very recently and should be considered experimental. Credits go to @darrenkopp and @am11 for their work on getting `libsass` and `sassc` to compile with visual studio! 20 21- [Building with MinGW][3] 22- [Building with Visual Studio][11] 23 24### Building on Max OS X (untested) 25 26Works the same as on linux, but you can also install LibSass via `homebrew`. 27 28- [Building on Mac OS X][10] 29 30### Building a system library (experimental) 31 32Since `libsass` is a library, it makes sense to install it as a shared library on your system. On linux this means creating a `.so` library via autotools. This should work pretty well already, but we are not yet committed to keep the ABI 100% stable. This should be the case once we increase the version number for the library to 1.0.0 or higher. On Windows you should be able get a `dll` by creating a shared build with MinGW. There is currently no target in the MSVC project files to do this. 33 34- [Building shared system library][4] 35 36Compiling with clang instead of gcc 37-- 38 39To use clang you just need to set the appropriate environment variables: 40 41```bash 42export CC=/usr/bin/clang 43export CXX=/usr/bin/clang++ 44``` 45 46Running the spec test-suite 47-- 48 49We constantly and automatically test `libsass` against the official [spec test-suite][5]. To do this we need to have a test-runner (which is written in ruby) and a command-line tool ([`sassc`][6]) to run the tests. Therefore we need to additionally compile `sassc`. To do this, the build files of all three projects need to work together. This may not have the same quality for all build flavors. You definitely need to have ruby (2.1?) installed (version 1.9 seems to cause problems at least on windows). You also need some gems installed: 50 51```bash 52ruby -v 53gem install minitest 54# should be optional 55gem install minitap 56``` 57 58Including the LibSass version 59-- 60 61There is a function in `libsass` to query the current version. This has to be defined at compile time. We use a C macro for this, which can be defined by calling `g++ -DLIBSASS_VERSION="\"x.y.z.\""`. The two quotes are necessary, since it needs to end up as a valid C string. Normally you do not need to do anything if you use the makefiles or autotools. They will try to fetch the version via git directly. If you only have the sources without the git repo, you can pass the version as an environment variable to `make` or `configure`: 62 63``` 64export LIBSASS_VERSION="x.y.z." 65``` 66 67Continuous Integration 68-- 69 70We use two CI services to automatically test all commits against the latest [spec test-suite][5]. 71 72- [LibSass on GitHub Actions (linux)][7] 73[](https://github.com/sass/libsass/actions/workflows/build-and-test.yml) 74- [LibSass on AppVeyor (windows)][8] 75[](https://ci.appveyor.com/project/sass/libsass/branch/master) 76 77Why not using CMake? 78-- 79 80There were some efforts to get `libsass` to compile with CMake, which should make it easier to create build files for linux and windows. Unfortunately this was not completed. But we are certainly open for PRs! 81 82Miscellaneous 83-- 84 85- [Ebuilds for Gentoo Linux](build-on-gentoo.md) 86 87[1]: build-with-makefiles.md 88[2]: build-with-autotools.md 89[3]: build-with-mingw.md 90[4]: build-shared-library.md 91[5]: https://github.com/sass/sass-spec 92[6]: https://github.com/sass/sassc 93[7]: https://github.com/sass/libsass/blob/master/.github/workflows 94[8]: https://github.com/sass/libsass/blob/master/appveyor.yml 95[9]: implementations.md 96[10]: build-on-darwin.md 97[11]: build-with-visual-studio.md 98
){kind=link}