ludit/README.md

Ludit is an interpreter for Ludi, a language meant to express and compute boolean algebra in the CLI.

<p align="center">
    <img src="https://i.ibb.co/Fg3d0dr/logo.png" alt="Ludit" height="100"/>
</p>

<h3 align="center">Boolean Algebra in the CLI</h4>
    
<p align="center">
  <a href="https://github.com/matiasvlevi/ludit/blob/parser/README.md">Install</a> •
  <a href="https://github.com/matiasvlevi/ludit/blob/parser/DOCUMENTATION.md">Documentation</a> •
  <a href="https://github.com/matiasvlevi/ludit/blob/parser/LICENCE">License</a>
</p>
    
<br/><br/>
    
Ludit is an interpreter for Ludi, a language meant to express and compute boolean algebra in the CLI.

Ludi allows you to generate truth tables and karnaugh tables.

<br/>

<table align="center">
<tr>
<td align="center"> Ludi Code </td> <td align="center"> Truth table </td>
</tr>
<tr>
<td>

```python
def and = A * B
def or  = A + B

or(and(A, !B), C)
```

</td>
<td>

<img src="https://i.ibb.co/VJXj67w/table-Demo.png" alt="luditable" height="310"/>

</td>
</tr>
<tr>
<td align="center">  </td> <td align="center"> Karnaugh </td>
</tr>
<tr>
<td>

```python
def and = A * B
def or  = A + B

or(and(A, !B), C) ~k
```

</td>
<td>

<img src="https://i.ibb.co/brfzTfX/karnaugh-Demo.png" alt="luditable" height="210"/>

</td>
</tr>
</table>




# Install
```
npm i -g ludit
```
(build from source for latest check `package.json`)


##### Install the standard lib (Optional)

Run `./install.sh` as root

<br/>

### Usage

Show help menu

```
ludit -h
```

<br/>

Write boolean equations

```
ludit "A * 'B + 'A * B"
```

<br/>

You can also run files with `-f`

```
ludit -f ./examples/project/main.ludi
```

[Read the language documentation](https://github.com/matiasvlevi/ludit/blob/parser/DOCUMENTATION.md)

<br/>

Syntax highlighting file for vim is provided under

```
.vim/ludi.vim
```