Vocab Acquisition & Comprehension Tool (VACT)

A CIS 278 Project

Installation

git clone https://github.com/AlexKCA/VACT.git

Dependencies

NOTE: This project depends on ncurses.h which is a Unix library. It has only been tested on Linux, but MacOS and other Unix-based OSs should work.

If you are using Windows, WSL should allow you to run this project. However, I haven't specifically tested it. Alternatively, you could use a full-on virtual machine. However, WSL is more convienient.

To build this project, you will need g++ and ncurses.h

Apt (Debian, Debian-based, WSL, Ubuntu, Linux Mint)

sudo apt install g++ libncurses-dev

Pacman (Arch, Arch-based)

sudo pacman -S ncurses gcc

Brew (MacOS)

brew install ncurses g++

Building & Running

To build the project, cd into VACT/src and run the following if on Unix

./build.sh

The following may be neccessary first

chmod +x *.sh

If on Windows, run the contents of the bash script. It can also be copied into a batch file.

In VACT/bin Run the project with

./main

Hotkeys

While viewing document:

q - quit
h - left
j - down
k - up
l - right
e - edit
x - increase buffer size
z - decrease buffer size

Workflow

1. Go to VACT/res/files/ and add a .txt file with the text you want to process (or don't; there are some default files).
2. Build and run.
3. Go through your file. Add entries to your dictionary and set your familiarity with particular words.