<commit_before>TouIST, the language for propositional logic
===========================================


|      Mac, Linux      |         Windows         | [Reference manual][ref] |    Come and discuss!    |
|:--------------------:|:-----------------------:|:-----------------------:|:-----------------------:|
| [![trv-img]][travis] | [![apvy-img]][appveyor] |  [![cir-img]][circle]   | [![gitter-img]][gitter] |

[circle]: https://circleci.com/gh/touist/touist/tree/master
[cir-img]: https://circleci.com/gh/touist/touist/tree/master.svg?style=svg
[travis]: https://travis-ci.org/touist/touist
[trv-img]: https://travis-ci.org/touist/touist.svg?branch=master
[appveyor]: https://ci.appveyor.com/project/maelvalais/touist-kila4/branch/master
[apvy-img]: https://ci.appveyor.com/api/projects/status/rayupfflmut8xbe0/branch/master?svg=true
[gitter]: https://gitter.im/touist-project/touist
[gitter-img]: https://badges.gitter.im/touist-project/touist.svg "Join the chat at https://gitter.im/touist-project/touist"

[![Screenshot of the graphical interface with a QBF
problem](docs/images/screenshot.png)](https://github.com/maelvalais/allumettes)

## Install

1. TouIST has a java-based graphical interface (which embeds the
   command-line tool). It be downloaded in the [releases] page and is available
   for Linux, Windows and macOS. Two options are available: the plain **jar**
   for any platform or the non-signed **native** version for macOS and
   Windows (see below warning).

   ⚠ WARNING ⚠ On macOS Sierra, the native `TouIST.app` will show a
   _broken_ message. You must run `sudo spctl --master-disable` which will
   enable the _Open apps from anywhere_.

   ⚠ WARNING ⚠ On Windows 10, the native `TouIST.exe` can't be opened unless
   the _Windows Defender SmartScreen_ feature is disabled. You can still use
   the **jar** version.

2. If you only want the command-line program `touist`, it can be installed
   using either brew ([linux](http://linuxbrew.sh/)/[mac](http://brew.sh),
   **recommended**) or [opam]:

       brew install https://raw.githubusercontent.com/touist/touist/master/touist.rb
       opam install yices2 qbf touist

   If you want to have the development version (may be unstable):

       brew install --HEAD https://raw.githubusercontent.com/touist/touist/master/touist.rb
       opam pin add touist --dev-repo

   Now, if we want to know if `a ⋀ b ⇒ c` is satisfiable:

       echo 'a and b => c' | touist - --solve

[opam]: https://opam.ocaml.org/doc/Install.html#Using-your-distribution-39-s-package-system

3. You can also look at the [TouIST reference manual][ref]
   ([pdf version][ref-pdf]).

4. Syntax coloring is also available for **[VSCode][vscode]** (search
   for the `touist` extension) and for **[Vim]** (Vim support is experimental).

   ![touist vscode extension](https://github.com/touist/touist-vscode/raw/master/images/screenshot.png)

[releases]: https://github.com/touist/touist/releases
[ref]: http://www.irit.fr/touist/doc/reference-manual.html
[ref-pdf]: http://www.irit.fr/touist/doc/reference-manual.pdf
[vscode]: https://marketplace.visualstudio.com/items?itemName=maelvalais.touist
[Vim]: https://github.com/touist/touist-vim

## Description

TouIST is a user-friendly tool for solving propositional logic problems using
a high-level logic language (known as the _bigand_ format or syntax or<commit_msg>readme: separated brew and opam install instructions<commit_after>TouIST, the language for propositional logic
===========================================


|      Mac, Linux      |         Windows         | [Reference manual][ref] |    Come and discuss!    |
|:--------------------:|:-----------------------:|:-----------------------:|:-----------------------:|
| [![trv-img]][travis] | [![apvy-img]][appveyor] |  [![cir-img]][circle]   | [![gitter-img]][gitter] |

[circle]: https://circleci.com/gh/touist/touist/tree/master
[cir-img]: https://circleci.com/gh/touist/touist/tree/master.svg?style=svg
[travis]: https://travis-ci.org/touist/touist
[trv-img]: https://travis-ci.org/touist/touist.svg?branch=master
[appveyor]: https://ci.appveyor.com/project/maelvalais/touist-kila4/branch/master
[apvy-img]: https://ci.appveyor.com/api/projects/status/rayupfflmut8xbe0/branch/master?svg=true
[gitter]: https://gitter.im/touist-project/touist
[gitter-img]: https://badges.gitter.im/touist-project/touist.svg "Join the chat at https://gitter.im/touist-project/touist"

[![Screenshot of the graphical interface with a QBF
problem](docs/images/screenshot.png)](https://github.com/maelvalais/allumettes)

## Install

1. TouIST has a java-based graphical interface (which embeds the
   command-line tool). It be downloaded in the [releases] page and is available
   for Linux, Windows and macOS. Two options are available: the plain **jar**
   for any platform or the non-signed **native** version for macOS and
   Windows (see below warning).

   ⚠ WARNING ⚠ On macOS Sierra, the native `TouIST.app` will show a
   _broken_ message. You must run `sudo spctl --master-disable` which will
   enable the _Open apps from anywhere_.

   ⚠ WARNING ⚠ On Windows 10, the native `TouIST.exe` can't be opened unless
   the _Windows Defender SmartScreen_ feature is disabled. You can still use
   the **jar** version.

2. If you only want the command-line program `touist`, it can be installed
   using either `brew` ([linux](http://linuxbrew.sh/)/[mac](http://brew.sh))
   or [`opam`][opam].

   Using `brew` (**recommended**):

       brew install https://raw.githubusercontent.com/touist/touist/master/touist.rb         # stable version
       brew install https://raw.githubusercontent.com/touist/touist/master/touist.rb --HEAD  # git-master version

   Using [`opam`][opam] (`yices2` and `qbf` are optionnal, you can skip them if
   you don't need the embedded SMT/QBF solvers):

       opam install yices2 qbf touist          # stable version
       opam pin add touist --dev-repo          # git-master version

   Now, if we want to know if `a ⋀ b ⇒ c` is satisfiable:

       echo 'a and b => c' | touist - --solve

[opam]: https://opam.ocaml.org/doc/Install.html#Using-your-distribution-39-s-package-system

3. You can also look at the [TouIST reference manual][ref]
   ([pdf version][ref-pdf]).

4. Syntax coloring is also available for **[VSCode][vscode]** (search
   for the `touist` extension) and for **[Vim]** (Vim support is experimental).

   ![touist vscode extension](https://github.com/touist/touist-vscode/raw/master/images/screenshot.png)

[releases]: https://github.com/touist/touist/releases
[ref]: http://www.irit.fr/touist/doc/reference-manual.html
[ref-pdf]: http://www.irit.fr/touist/doc/reference-manual.pdf
[vscode]: https://marketplace.visualstudio.com/items?itemName=maelvalais.touist
[Vim]: https://github.com/touist/touist-vim

## Description

TouIST is a user-friendly tool for solving propositional logic problems using
a high-level logic language (known as the _bigand_ format or syntax or
{'fraction_non_alphanumeric': 0.17325315005727376, 'fraction_numerical': 0.003579610538373425, 'mean_word_length': 3.480436177036562, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 34, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3884163', 'n_tokens_mistral': 2386, 'n_tokens_neox': 2315, 'n_words': 609}