/DeepReader

Group project for CSCI-2963

Primary LanguageC++GNU General Public License v3.0GPL-3.0

DeepReader

What is DeepReader?

DeepReader, initially created as a CSCI2963 project, is an application that increases comprehension of textbooks by requiring the user to take notes as they read, and then checking the quality of the notes. DeepReader is implemented mainly in C++, using QtWidgets and Poppler.

How do I run DeepReader?

Download Qt Creator version 4.5 and Poppler Qt5. Instructions on installing both can be found in the DeepReader Wiki. From there open all files in the DeepReader folder in Qt Creator (Open Qt Creator -> File -> Open Project -> Select all files in DeepReader folder -> Open) and hit the run button. This will execute the application.

License

GNU General Public License v3.0

How can I contribute?

If you're looking to get involved with DeepReader first take a look at open issues. If there are any open issues you are welcome to contribute! In addition if you're planning on contributing join our channel on slack. We have a slack channel for DeepReader at RCOS.slack.com, please email madisonawheeler@gmail.com or contact any other contributors to be added to the slack. If no issues are open feel free to contribute in smaller ways such as fixing spelling errors or adding documentation. You could also fork your own version of DeepReader to add anything you'd like, if there are any features you think should be added or any issues you see we encourage you to post them in the slack.

Some unfinished features you could continue or start implementing include:

  • Support for Operating Systems other than Linux (MacOS & Windows)
  • Create a stand alone executable
  • Line spacing and other formatting features such as bullets
  • Chapter question viewer
  • Chapter question answer checker
  • Timer display

Current Contributors

Eric Lawson, Madison Wheeler, Shoshana Malfatto, and Birchell Eversole.