From 52dd58218068c02cd731da95f802e547f3cc6005 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Guzm=C3=A1n=20=C3=81lvarez?= Date: Mon, 22 Jan 2024 19:12:17 +0100 Subject: [PATCH] Updated README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5239c97..25526e4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # decmathlib-rs -Port to [Rust](https://www.rust-lang.org/) of the decimal128 type from [Intel Decimal Floating-Point Math Library](https://www.intel.com/content/www/us/en/developer/articles/tool/intel-decimal-floating-point-math-library.html) + +Port of the Intel Decimal Floating-Point Math Library decimal128 type to Rust. + +## Acknowledgements + +- [Intel Decimal Floating-Point Math Library](https://www.intel.com/content/www/us/en/developer/articles/tool/intel-decimal-floating-point-math-library.html) +- [readme.so](https://readme.so/editor) + +## Badges + +Add badges from somewhere like: [shields.io](https://shields.io/) + +[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) + +## License + +[MIT](https://choosealicense.com/licenses/mit/) + +## Build Locally + +Clone the project + +```bash + git clone https://github.com/carlosga/decmathlib-rs +``` + +Go to the project directory + +```bash + cd decmathlib-rs +``` + +Build (Cargo) + +```bash + cargo build +``` +## Running Tests + +To run tests, run the following command + +```bash + cargo test +``` \ No newline at end of file