From db0712f35a560ce4113576402482d05299504bd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kornel=20Budzy=C5=84ski?= Date: Thu, 7 Jun 2018 09:02:40 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6e71f46..ee1550b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Logic formula checker -Script for checking is formula is correct +Script for checking if formula is correct ### Installation You can run this script without downloading any other libraries. ### Usage There are several ways of usage. -+ You can use is as a library in your project: ++ You can use it as a library in your project: ``` from logic_formula_checker import is_formula_correct ``` @@ -17,21 +17,21 @@ There are several ways of usage. ``` ### Testing -Some tests is written in tests.py file. They check if formula single tests work properly. +Some tests are written in tests.py file. They check if formula's single tests work properly. ## Script logic explaination -It takes two test of formula for checking formula's correctness. -Firstly check if all brackets are properly opened and closed. +It takes two tests of formula for checking formula's correctness. +Firstly, check if all brackets are properly opened and closed. ``` ( { } ) - Good ( { ) } - Wrong ( { } - Wrong ``` -Next script checks if signs are rightly put. Brackets are bypassed. Steps: -1. Read sign, check what kind it is (Types are in logic_formula_checker/types.py). +The next script checks if signs are put correctly. Brackets are bypassed. Steps: +1. Read sign, check its type (Types are in logic_formula_checker/types.py). 2. Check if it is in expected_sign list. -3. Update expected_sign list base on current sign +3. Update expected_sign list based on current sign. ``` a ^ ¬ b # take a, write to expected_sign conjuction symbols and negation symbols