Terminal Book Management System

An experimental terminal user interface book management system for your needs!
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Acknowledgements

About The Project

Built With

• FTXUI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The project is reliant on a few standard C++ tools.

• g++/gcc (Or an alternative such as clang)
• CMake

Installation

1. Clone the repository on your computer

   git clone https://github.com/Hunter-Zolomon/tuibms.git

2. Navigate to the cloned directory

   cd tuibms

3. Create a build directory for the program and navigate to it

   mkdir build && cd build

4. Configure CMake

   cmake ..

5. Build the program

   make

6. (Optional) Install binary to appropriate computer path

   make install

Usage

No documentation is available at the moment.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL License. See LICENSE for more information.

Acknowledgements

• Arthur Sonzogni (FTXUI)