<commit_before># Scheduler

A simple course auto-scheduler. Feed in an array describing each course (format below) and receive a set of possible
non-conflicting course sections.

_Documentation is in progress... More detailed usage and feature descriptions are upcoming._

## Format (TypeScript-style)

```ts
interface Course {
    code: string,
    sections: {
        identifier: string,
        sessions: {
            day: number,
            location: {
                building: string,
                room: string,
            },
            start: {
                hour: number,
                minute: number
            },
            end: {
                hour: number,
                minute: number
            }
        }[]
    }[]
}
```<commit_msg>Add usage information to README<commit_after># Scheduler

A simple course auto-scheduler. Feed in an array describing each course (format below) and receive a set of possible
non-conflicting course sections.

*Note: TypeScript-style type annotations and syntax will be used throughout this document*

## Format

```ts
interface RawCourse {
    code: string,
    sections: {
        identifier: string,
        sessions: {
            day: number,
            location: {
                building: string,
                room: string,
            },
            start: {
                hour: number,
                minute: number
            },
            end: {
                hour: number,
                minute: number
            }
        }[]
    }[]
}
```

## Usage

### Import the parser

#### CommonJS

```js
const scheduler = require('course-scheduler');
const parseCourses = scheduler.parseCourses;
const Course = scheduler.Course;
```

#### ES2015+ Module

```js
import { parseCourses, Course } from 'course-scheduler';
```

### Parse the array of courses

```ts
const rawCourses: RawCourse[] = /* some array */;

const parsedCourses: Set<Course> = parseCourses(rawCourses);

const sectionCombinations: Set<Map<Course, Section>> = Course.possibleSectionCombinations(parsedCourses);
```

*More details about how to proceed with the return `sectionCombinations` will be added soon*
{'fraction_non_alphanumeric': 0.0976399814900509, 'fraction_numerical': 0.0018509949097639982, 'mean_word_length': 2.066666666666667, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, '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': '843489', 'n_tokens_mistral': 584, 'n_tokens_neox': 552, 'n_words': 188}