<commit_before>teensylc_fibers
===============

This is a Teensy-LC Lightweight Fibers Project, derived from the teensy3_fibers project.


Status:
-------

This is being ported to the Teensy-LC and is not yet complete.


HOW TO:
-------

Install this directory in your Arduino library folder. On a Mac, this
will be in the directory ~/Documents/Arduino/libraries. In other words,
install these files in the directory (on Mac)

    ~/Documents/Arduino/libraries/fiberslc

    $ cd ~/Documents/Arduino/libraries
    $ git clone <EMAIL>:ve3wwg/teensylc_fibers.git

Then start your Arduino IDE, and pull down the menu Sketch->Import
Library. At the bottom of the menu, underneath "Contributed", select the
entry "fibers". If successful, the line

#include <fiberslc.h> 

should appear in your sketch.


Fibers API Usage:
-----------------
 
Somewhere it is recommended that you declare one instance of
Fibers globally. Global access makes it available from other
modules when it is time to "yield". Alternatively, your code
could call the globally available C function yield(), if you
define it as follows:

      void yield() {
              fibers.yield();
      }

The Fibers class is a template class, requiring a template parameter,<commit_msg>Reported to be working<commit_after>teensylc_fibers
===============

This is a Teensy-LC Lightweight Fibers Project, derived from the teensy3_fibers project.


Status:
-------

This library has been successfully ported to the Cortex-M0.


HOW TO:
-------

Install this directory in your Arduino library folder. On a Mac, this
will be in the directory ~/Documents/Arduino/libraries. In other words,
install these files in the directory (on Mac)

    ~/Documents/Arduino/libraries/fiberslc

    $ cd ~/Documents/Arduino/libraries
    $ git clone <EMAIL>:ve3wwg/teensylc_fibers.git

Then start your Arduino IDE, and pull down the menu Sketch->Import
Library. At the bottom of the menu, underneath "Contributed", select the
entry "fibers". If successful, the line

    #include <fiberslc.h> 

should appear in your sketch.


Fibers API Usage:
-----------------
 
Somewhere it is recommended that you declare one instance of
Fibers globally. Global access makes it available from other
modules when it is time to "yield". Alternatively, your code
could call the globally available C function yield(), if you
define it as follows:

      void yield() {
              fibers.yield();
      }

The Fibers class is a template class, requiring a template parameter,
{'fraction_non_alphanumeric': 0.0952, 'fraction_numerical': 0.002, 'mean_word_length': 3.4422735346358793, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7068501', 'n_tokens_mistral': 751, 'n_tokens_neox': 681, 'n_words': 315}