Skip to content

Commit 0a1fc5a

Browse files
Revise README
Updated the README to clarify features and usage examples.
1 parent 7cf26c8 commit 0a1fc5a

1 file changed

Lines changed: 8 additions & 33 deletions

File tree

README.md

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,17 @@
22

33
[booleanalgbravisualizer.github.io](https://booleanalgbravisualizer.github.io/)
44

5-
A tool to visualize, analyze, and simplify boolean expressions. This visualizer provides real time generation of logic circuits, CMOS layouts, truth tables, and Karnaugh maps.
5+
A tool to visualize and generate diagrams of boolean expressions.
66

7-
## Features
87

9-
### Parsing
10-
The visualizer uses a robust recursive descent parser that supports a wide variety of input formats:
11-
- **Operators**: `+` (OR), `*` (AND), `!` (NOT), `^` (XOR).
12-
- **Universal Gates**: NAND, NOR, XNOR.
13-
- **Keywords**: Supports text-based operators like `AND`, `OR`, `NOT`, `NAND`, etc.
14-
- **Symbols**: Familiar programming symbols like `&`, `|`, and `~`.
8+
Supports a wide variety of input formats:
9+
- **Operators**: `+` (OR), `*` (AND), `!` (NOT), `^` (XOR)
10+
- **Keywords**: Supports text-based operators like `AND`, `OR`, `NOT`, `NAND`,`NOR`, `XNOR`.
11+
- **Symbols**: Programming symbols like `&`, `|`, and `~`.
1512
- **Shorthand**: Supports implicit AND (e.g., `AB`) and postfix NOT (e.g., `A'`).
1613

1714
### Visualizations
18-
- **Logic Gate Diagrams**: Dynamic SVG generation with proportional spacing for clear, readable schematics.
19-
- **CMOS Circuits**: Visualizes Complementary Metal-Oxide-Semiconductor layouts, detailing:
20-
- **Pull-Up Network (PUN)**: PMOS transistor arrangement.
21-
- **Pull-Down Network (PDN)**: NMOS transistor arrangement.
22-
- **Truth Tables**: Precise evaluation of all variable combinations.
15+
- **Logic Gate Diagrams**
16+
- **CMOS Circuits**: Visualizes Complementary Metal-Oxide-Semiconductor layouts.
17+
- **Truth Tables**
2318
- **Karnaugh Maps (K-Maps)**: Interactive maps supporting 2 to 8+ variables using standard Gray code ordering and nested grid layouts for higher dimensions.
24-
25-
### Clipboard & Export Tools
26-
- **Rich Text Copy**: Format tables directly for pasting into Google Docs or Microsoft Word with styles preserved.
27-
- **CSV Export**: Download truth tables and K-maps for spreadsheet analysis.
28-
- **LaTeX Export**: Generate LaTeX code for inclusion in academic papers or reports.
29-
30-
## Usage
31-
32-
Enter a boolean expression into the input field. The parser is flexible and accepts multiple formats.
33-
34-
### Examples
35-
| Logic | Input Example | Alternative |
36-
|-------|--------------:|-------------|
37-
| **AND** | `A * B` | `AB`, `A and B`, `A & B` |
38-
| **OR** | `A + B` | `A or B`, `A | B` |
39-
| **NOT** | `!A` | `A'`, `~A`, `not A` |
40-
| **NAND** | `A nand B` | `A ↑ B` |
41-
| **NOR** | `A nor B` | `A ↓ B` |
42-
| **XOR** | `A ^ B` | `A xor B` |
43-
| **Complex** | `(A+B)*C` | `(!A B) + (C ^ D)` |

0 commit comments

Comments
 (0)