Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trying to make the docs better #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Trying to make the docs better
  • Loading branch information
saurabhnanda authored Jul 14, 2018
commit 9b324c0de1277b15e5073fd8b9c8de455a192053
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,38 @@ hLibsass supports three different ways of linking with Libsass:
2. Shared, locally-built LibSass, requires setting `sharedLibsass` flag,
3. External (e.g. system package), requires setting `externalLibsass` flag.

You can pick your preferred option by editing your projects `stack.yaml` file thus:

```
# THIS SHOULD BE IN YOUR stack.yaml FILE

flags:
hlibsass:
sharedlibsass: false
externallibsass: true
```

**What do these configuration flags mean?**

| sharedlibsas | externallibsass | Behaviour |
| --- | --- | --- |
| false | false | Static, locally built libsass will be used |
| true | false | Shared, locally built libsass will be used |
| N/A | true | External libSass provided by your system's package manager will be used. If `externallibsass=true` then the `sharedlibsass` flag is ignored |

**Caveats for using "Static, locally built libsass"**

TODO

**Caveats for using "Shared, locally built libsass"**

TODO

**Caveats for using "External libsass"**

TODO


The first two options rely on the LibSass being distributed with the `hlibsass` package and compiled during configure/build process. hLibsass is always distributed with LibSass version that is compatibile with the package.

Up until version `0.1.6.0`, the first option was preferred, because LibSass has been distributed as a source package only. Development package of LibSass is now available in most Linux distributions and in Homebrew, so using it is equally good option
Expand Down