phillits / lang

A collection of C++ classes representing fundamental linguistic units and building blocks of language from phonetics to pragmatics.

Lang {#top}

A collection of C++ classes representing fundamental linguistic units and building blocks of language from phonetics to pragmatics.

A project by Tyler Phillips

Overview of the project {#overview}

The basic idea of this project is to create a set of classes representing the basic components of language, with the goal that these classes could form a foundation for a wide variety of linguistic applications. I'm trying to design these classes so that they could be used for as many different applications as possible.

Disclaimer {#disclaimer}

I am a student and a relatively inexperienced programmer. I hope that this project can be useful, but I'm mainly doing it for fun and to improve my programming skills.

Organization of the project {#overview}

I have split the project up according to the major subfields of linguistics.
Each subfield has a folder, and each folder contains a header file, an implementation file, and a test file.

Workflow {#workflow}

I'm following a simple workflow pattern for each subfield:

1. Write a header file.

2. Write unit tests.

3. Implement.

4. Test and fix as needed.

Contributing {#contributing}

I welcome contributions if anyone wants to work on this project with me. Feel free to contact me about contributing at [email protected].

Documentation {#documentation}

Documentation for this project is provided in the documentation directory.
Documentation is divided into a separate file for each subfield, and an overarching table of contents is provided which lists all resources provided by this project and which subfield they occur in.

lang's Issues

Write header

Design the phonemics library in a header file.

Readme needed

This repository needs a readme file.

Code of conduct needed

This repository needs a code of conduct.

Implement functions

Implement and test the non-member functions in the phonetics library.

Issue template needed

This repository needs an issue template.

Implement Syllable

Implement and test the Syllable class in the phonetics library.

Phonetics unit tests

Write unit tests for each function and class in the phonetics portion of this project.

Implement Consonant

Implement and test the Consonant class in the phonetics library.

Implement ImpossibleArticulation

Implement and test the ImpossibleArticulation class in the phonetics library.

Contributing guidelines needed

This repository needs contributing guidelines.

Implement Tone

Implement and test the Tone class in the phonetics library.

Implement Vowel

Implement and test the Vowel class in the phonetics library.

Implement Phone

Implement and test the Phone class in the phonetics library.

Write unit tests

Write unit tests for every function and class in the phonemics library.

Pull-request template needed

This repository needs a pull-request template.