<commit_before>Project: KRLX

Client: <NAME>

Team members: <NAME>, <NAME>, <NAME> and <NAME>

Description of KRLX: KRLX is a iOS-based application (an application version of KRLX website). KRLX live streams KRLX Carleton radio and pulls articles from the website and displays them in a readable way. 
It will also integrate social media sharing options for the content, shows schedule of radio shows, displays which show is currently playing and have a playing song history of 5 most recently heard songs. 
The goal of creating this application is to enable more students enjoying and accessing KRLX radio, hence giving KRLX more listeners.

Instruction to install:

* When you clone the project, the Google Calendar API key will be missing. You will need to add a new file in the directory (folder KRLX) named GoogleCalCredentials.txt. The text contains only the API key. Then, drag the file into the Project Navigator in Xcode (The folder tab under the left menu, that lists all of the files in a hierarchical layout).
We use a SidebarMenu library (created by Simon Ng), libxml2 and Swift-HTML-Parser (by TID) which will be installed as you download and pull the repository.

* Also, since KRLX does not stream during the summer, we have a dummy radio station in our app. To change back to KRLX, go to line 25 in AppDelegate.swift, uncomment that line, and comment the line below.

Other Notes:
* In the summer, KRLX does not stream, so the schedule table may be empty depending on the actions of the calendar creator.
* In NewsTableViewController, ArticleViewController, and RecentlyHeardTableViewController we scrape from the KRLX website. There is some incorrect HTML tagging on the website, and that causes some output (ex "HTML parser error") in the console. We do not have access to the code that creates that out; it is in a library, so we were not able to suppress it.
* The correctness of the recently heard song depends on KRLX's DJ and the website source. We do not have the means and access to ensure the song always match the radio

Note to future developers:<commit_msg>README.txt edited online with Bitbucket<commit_after>Project: KRLX

Client: <NAME>

Team members: <NAME>, <NAME>, <NAME> and <NAME>

Description of KRLX: KRLX is a iOS-based application (an application version of KRLX website). KRLX live streams KRLX Carleton radio and pulls articles from the website and displays them in a readable way. 
It will also integrate social media sharing options for the content, shows schedule of radio shows, displays which show is currently playing and have a playing song history of 5 most recently heard songs. 
The goal of creating this application is to enable more students enjoying and accessing KRLX radio, hence giving KRLX more listeners.

Instruction to install:

* When you clone the project, the Google Calendar API key will be missing. You will need to add a new file in the directory (folder KRLX) named GoogleCalCredentials.txt. The text contains only the API key. Then, drag the file into the Project Navigator in Xcode (The folder tab under the left menu, that lists all of the files in a hierarchical layout).
We use a SidebarMenu library (created by Simon Ng), libxml2 and Swift-HTML-Parser (by TID) which will be installed as you download and pull the repository.
We did not write any files in the SWRevealViewController folder or Swift-HTML-Parser directories.

* Also, since KRLX does not stream during the summer, we have a dummy radio station in our app. To change back to KRLX, go to line 25 in AppDelegate.swift, uncomment that line, and comment the line below.

Other Notes:
* In the summer, KRLX does not stream, so the schedule table may be empty depending on the actions of the calendar creator.
* In NewsTableViewController, ArticleViewController, and RecentlyHeardTableViewController we scrape from the KRLX website. There is some incorrect HTML tagging on the website, and that causes some output (ex "HTML parser error") in the console. We do not have access to the code that creates that out; it is in a library, so we were not able to suppress it.
* The correctness of the recently heard song depends on KRLX's DJ and the website source. We do not have the means and access to ensure the song always match the radio

Note to future developers:
{'fraction_non_alphanumeric': 0.03908794788273615, 'fraction_numerical': 0.0018613308515588647, 'mean_word_length': 4.539948453608248, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '554369', 'n_tokens_mistral': 1067, 'n_tokens_neox': 1033, 'n_words': 700}