Skip to content

Commit

Permalink
Add a special README before the PR is merged by the upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
rwxe committed Sep 28, 2023
1 parent 81f26a5 commit 8eaf443
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
[![Build Status](https://travis-ci.org/JohnCGriffin/overflow.png)](https://travis-ci.org/JohnCGriffin/overflow)
# overflow
Check for integer overflow in Golang arithmetic and type conversion.
### Install

*This is a special README before the PR is merged by the upstream.*

This repository forks from `johncgriffin/overflow` and adds overflow detection for unsigned
integer arithmetic and type conversions between integers.
It has been well tested and benchmarked, and passed the code security scan provided by
Github Workflow.

[![CodeQL](https://github.com/rwxe/overflow/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/codeql.yml) [![DevSkim](https://github.com/rwxe/overflow/actions/workflows/devskim.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/devskim.yml) [![Codacy Security Scan](https://github.com/rwxe/overflow/actions/workflows/codacy.yml/badge.svg?branch=master)](https://github.com/rwxe/overflow/actions/workflows/codacy.yml)


```sh
go get github.com/johncgriffin/overflow
go get github.com/rwxe/overflow
```
Note that because Go has no template types, the majority of repetitive code is
generated by overflow_template.sh. If you have to change an
algorithm, change it there and regenerate the Go code via:
In order to be compatible with old code, and when this project was created, there were no
generics in Go, so the majority of repetitive code is generated by `overflow_template.sh`.
If you have to change an algorithm, change it there and regenerate the Go code via:

```sh
go generate
```
Expand All @@ -19,7 +30,7 @@ package main

import "fmt"
import "math"
import "github.com/JohnCGriffin/overflow"
import "github.com/rwxe/overflow"

func main() {

Expand Down

0 comments on commit 8eaf443

Please sign in to comment.