48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# Library Manager
|
|
|
|
**Authors**: [Nathan Singer](https://github.com/SuperNovaa41), [Shayan Rashid](https://github.com/ShyProton)
|
|
|
|
## What is it?
|
|
|
|
A simple desktop tool that lets you create, view, and manage a digital list of books.
|
|
|
|
## Uses
|
|
|
|
Perhaps you have a lot of books and you would like to digitize them.
|
|
Perhaps you want to create a list of books you would like to read, buy, or whatever the case may be.
|
|
|
|
Regardless, this tool makes it easy.
|
|
|
|
Simply import a list of ISBNs (TODO: eventually have some method of scanning the books to import the ISBNS.. not sure) and watch as our tool collects all of the information about the books you've collected and organizes into a easy to view list.
|
|
|
|
## Features
|
|
|
|
TODO:
|
|
|
|
## How to use
|
|
|
|
### Usage
|
|
|
|
... blah blah how to use the app, need to finish it first
|
|
|
|
|
|
### Installation
|
|
|
|
... TODO: create an install script of some sort, or maybe just compile a release and add it to release, then link that here
|
|
|
|
|
|
### Compiling
|
|
|
|
**Dependencies**: [ISBN-lookup](https://github.com/SuperNovaa41/isbn-lookup), [CrowCPP](https://crowcpp.org), wget, .. im sure theres more
|
|
|
|
To compile the backend simple run `make` in the source directory.
|
|
To compile the front end.... blah blah (maybe and HOPEFULLY hook it into the makefile)
|
|
|
|
|
|
# TODOs:
|
|
|
|
- Fix the tests to use crow.h so it actually functions
|
|
- Connect the REST backend to the front end
|
|
- Finish adding the features from the isbn into the backend
|
|
- ...
|