KarnaughMap 1.0.5

Dependency-free library to create Karnaugh Map objects which can be solved and manipulated (GUI and CLI included)

Karnaugh Maps

Dependency-free library to create Karnaugh Map objects which can be solved and manipulated (GUI and CLI included)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

I was inspired by a topic that I was studying at school and so I made a program to solve Karnaugh maps

Built With

• Python version >= 3.8
• May work with earlier versions but it is untested feel free to try it by downloading from my github https://github.com/BizTecBritain/KarnaughMap

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install git and python

   $ sudo apt-get update
   $ sudo apt-get install git
   $ sudo apt-get install python
  

Installation

Clone the repo with $ git clone https://github.com/BizTecBritain/KarnaughMap.git Or install with $ pip install KarnaughMap

Usage

This can be used as a library (see documentation) or run from the command line (you need to add to PATH)

• To run the standard command line interface run:

  $ KMap.exe expression [-h] [--print-map] [--debug] [--tot-input TOT_INPUT]
  
  positional arguments:
    expression            Unsimplified expression to simplify
  
  optional arguments:
    -h, --help            show this help message and exit
    --print-map, -p       Whether to print the map or not
    --debug, -d           Debug mode (verbose)
    --tot-input TOT_INPUT, -i TOT_INPUT
                          Total number of inputs (Optional)
  

• To run the GUI from the command line run:

  $ KMapGUI.exe
  

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alexander Bisland - Twitter: @BizTecBritain - Email: [e-mail]

Project Link: https://github.com/BizTecBritain/KarnaughMap

Acknowledgements

• Thanks to othneildrew for the blank README.md file