Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kumbong authored Jun 23, 2019
1 parent cd7fa56 commit e652148
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,35 @@ A CLI/GUI tool for minimizing sum of products via the Quine McCluskey minimizati

## Installation
1. Clone the repo
```python
```bash
git clone https://github.com/Kumbong/quine_mccluskey.git
cd quine_mccluskey/
cd quine_mccluskey
```
2. Install dependencies
```python
```bash
pip install -r requirements.txt
```

## Usage
You can use the following optional arguments according to your needs:

* `-d`, `--dcares` (list of numbers): **list of dont't cares (default=0,1,2,3,4,5,6)**
* `-v`, `--variables` (list of chars): **list of characters for representing result (default = [])**
* `-s`, `--show_steps` (yes|no): **show steps leading to solution (default=[])**
* `-d`, `--dcares` (list of numbers): **list of dont't cares (default=[ ])**
* `-v`, `--variables` (list of chars): **list of characters for representing result (default = [ ])**
* `-s`, `--show_steps` (yes|no): **show steps leading to solution (default=yes)**

Example
```python
```bash
python -m qmccluskey 0,1,3,7,8,9,11,15 -d 12 -v a,b,c,d
```


## Demo
Solution for the the Example above

![](assets/images/grouping.png)
![](assets/images/combining.png)
![](assets/images/coverage.png)
![](assets/images/solution.png)

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Expand All @@ -50,7 +57,7 @@ Please make sure to update tests as appropriate.

- Complete GUI module
- Write tests

- Include steps for petrick's method


License
Expand Down

0 comments on commit e652148

Please sign in to comment.