nim-stint/README.md

# Stint (Stack-based multiprecision integers)

[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-stint/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-stint)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-stint/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-stint)
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
![Github action](https://github.com/status-im/nim-stint/workflows/CI/badge.svg)

A fast and portable stack-based multi-precision integer library in pure Nim

Main focus:
  - Portability
    - 32 and 64 bit arch
    - ARM for usage on mobile phones
    - Additionally RISC-V and MIPS for open hardware and low power IoT devices.
  - Speed, library is carefully tuned to produce the best assembly given the current compilers.
    However, the library itself does not resort to assembly for portability.
  - No heap/dynamic allocation
  - Ethereum applications
    - Uint256/Int256 for Ethereum Virtual Machine usage.
    - Uint2048 for Ethereum Bloom filters
  - Ease of use:
    - Use traditional `+`, `-`, `+=`, etc operators like on native types
    - Representation of numbers in memory is the exact same as native types and endianness aware.
      - In practice that means that interfacing with binary blobs representing numbers from cryptographic    libraries can be done with a `cast` if it represents a Uint256, Uint512, Uint1024, Uint2048.
    - converting to and from Hex
    - converting to and from decimal strings

## License

Licensed and distributed under either of

* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT

or

* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This file may not be copied, modified, or distributed except according to those terms.
Rename the library to Stint (#26) 2018-04-25 12:52:00 +02:00			`# Stint (Stack-based multiprecision integers)`
initial commit 2018-02-15 13:11:01 +01:00
Prefix repo with nim 2018-04-25 14:08:31 +02:00			`[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-stint/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-stint)`
ci: update readme: fix license, badges 2018-09-04 23:09:11 -06:00			`[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-stint/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-stint)`
Update License badge to Apache 2018-03-02 11:33:57 +01:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
Add Appveyor badge + use the blue MIT badge 2018-05-08 15:30:58 +02:00			`[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)`
initial commit 2018-02-15 13:11:01 +01:00			`![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
CI: refactor Nim compiler caching (#108) 2021-06-03 01:55:01 +02:00			`![Github action](https://github.com/status-im/nim-stint/workflows/CI/badge.svg)`
initial commit 2018-02-15 13:11:01 +01:00
Rename the library to Stint (#26) 2018-04-25 12:52:00 +02:00			`A fast and portable stack-based multi-precision integer library in pure Nim`
initial commit 2018-02-15 13:11:01 +01:00
			`Main focus:`
Rename the library to Stint (#26) 2018-04-25 12:52:00 +02:00			`- Portability`
			`- 32 and 64 bit arch`
			`- ARM for usage on mobile phones`
			`- Additionally RISC-V and MIPS for open hardware and low power IoT devices.`
			`- Speed, library is carefully tuned to produce the best assembly given the current compilers.`
			`However, the library itself does not resort to assembly for portability.`
			`- No heap/dynamic allocation`
			`- Ethereum applications`
			`- Uint256/Int256 for Ethereum Virtual Machine usage.`
			`- Uint2048 for Ethereum Bloom filters`
initial commit 2018-02-15 13:11:01 +01:00			`- Ease of use:`
Rename the library to Stint (#26) 2018-04-25 12:52:00 +02:00			- Use traditional `+`, `-`, `+=`, etc operators like on native types
			`- Representation of numbers in memory is the exact same as native types and endianness aware.`
			- In practice that means that interfacing with binary blobs representing numbers from cryptographic libraries can be done with a `cast` if it represents a Uint256, Uint512, Uint1024, Uint2048.
			`- converting to and from Hex`
			`- converting to and from decimal strings`
Relicense under dual Apache/MIT 2018-03-02 11:48:08 +01:00
			`## License`

readme: update license 2018-09-05 12:48:40 -06:00			`Licensed and distributed under either of`

			`* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT`

Update README.md 2019-01-02 14:57:16 +01:00			`or`

			`* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)`
Relicense under dual Apache/MIT 2018-03-02 11:48:08 +01:00
Update README.md 2019-01-02 14:57:16 +01:00			`at your option. This file may not be copied, modified, or distributed except according to those terms.`