Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 2.97 KB

README.md

File metadata and controls

91 lines (61 loc) · 2.97 KB
Raw


Awesome CI Workflow Codacy Badge License: BSL GitHub forks

bigINT

Big Integer(Library) Support for C++

LICENSE

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributions

Contributors are welcome!

Currently we have the minimal project setup, we will keep on improving the repository standards as soon as we progress.

We aim to build a library for C++ 17 or above for big integer support

  • Feel free to give suggestions or point bugs by rasing issues

Required Tools

  • CMake 3.16.8 or above ( you can download CMake from here )
  • GCC 7.5.0 or above

Installation

# fork the repository in your account
# clone the forked repository on your system

git clone https://github.com/[username]/bigINT.git

# for building the project locally make a build directory

mkdir build && cd build

# configure the project using CMake

cmake ..

# after configuration run

make

## for running tests go to /scripts and execute

sh test_runner.sh

# or alternatively you can use

# for running tests of operators

cd build/tests/operators
ctest

# for running tests of operations

cd build/tests/operations
ctest