added more to the readme

This commit is contained in:
2025-01-24 23:53:34 +00:00
parent c340004d37
commit 2fad0a2a4c

View File

@@ -1,5 +1,26 @@
# Pickler
__Pickler__ is a testing sweet centered around pickles.
Have you ever just wanted pickles to the point where you needed them in your code.
Well do we have the test sweet for you. We prosent __PICKLER__ the _light weight_
unpickling API. Let me ask you this. Is your code _stuck in a pickle_ well, this
AIP will salve all of your _pickle stuck_ situations. Just include this into your
__cmake project__ and start writing with pickles.
# Techinal Definitions
So __PICKLER__ alows for unit testing with 100% natrual pickles. _Not the GMO testing
that you get with the googles goods._ Lets go back to basics, what is a pickle?
- __Pickle__ : Is a unit test.
- **Pickle_Jar** : This allows use to catagorize the pickles and tests them.
- **Pickle_Shelf** : This holds all of the *Pickle_Jars* and tests all of the
jars.
The definitions for passing a test are a little different. Here are the definitions.
- __Pickled__ : This means that a pickle test passed.
- __Droped the Pickle__ : This means that a pickle test failed.
- __Pickles In Jar__ : This means that all pickles passed.
- __Pickle Jar Broke__: This means that one or more of the pickles failed there
test.
- __Pickle Shelf Good__ : This means that all Pickle Jars passed.
- __Pickle Shelf Fell__ : This means that one or more Pickle Jars failed.
# How To Use
To init the Pickler Lib first include Pickler.h