Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
slysterous committed Apr 13, 2021
1 parent 55bf77e commit b125cb6
Showing 1 changed file with 12 additions and 23 deletions.
35 changes: 12 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,10 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/slysterous/numeral)](https://goreportcard.com/report/github.com/slysterous/numeral)

numerals based on custom positional (numeral) systems.
## Table of Contents ##
* [Table of Contents](#table-of-contents)
* [About](#about)
+ [Why](#why)
+ [How](#how)
+ [What](#what)
* [Getting Started](#getting-started)
* [Usage](#usage)
+ [Make Utilities](#make-utilities)
* [Contributing](#contributing)
* [Report bugs using Github's [issues](https://github.com/slysterous/numeral/issues)](#report-bugs-using-github-s--issues--https---githubcom-slysterous-numeral-issues-)
* [License](#license)
## About ##

### Why

## 📝 About ##

### 🧠 Why
There are times, where we need to iterate over an X amount of possible combinations of values over a specific number or a specific string etc.
<strong> (iterators, rainbow tables, numeral system converters) </strong>

Expand All @@ -44,7 +33,7 @@ Now, if you wanted to find all the possible combinations of numbers, for 4 digit
```
These are <strong>916.132.832</strong> different possible combinations.

### How
### ♟️ How
A <strong>numeral</strong> is a symbol or group of symbols that <strong>represents a number</strong>. numeral are not the
same as numbers just as words are not the same with the things they refer to. The symbols <strong>"11", "1011" and "B"</strong>
are different numeral, all representing the same number.
Expand Down Expand Up @@ -86,7 +75,7 @@ In general, in base-b, there are b digits and the number
![base equation](https://latex.codecogs.com/png.latex?\bg_white&space;a_3a_2a_1a_0=(a_3%20*%20b^3)+(a_2*b^2)+(a_1*b^1)+(a_0*b^0))
(Note that ![base digits](https://latex.codecogs.com/png.latex?\bg_white&space;a_3a_2a_1a_0) represents a sequence of digits, not multiplication)

### What
### What
This library, <strong>numeral</strong> provides the ability to create custom positional numeral systems in an efficient and performant way.
You can create numerals based on custom numeral systems and use them at will.

Expand All @@ -103,9 +92,9 @@ Each number is represented as a doubly linked list of circular lists.
When a digit rotates back to it's first digit as a result of an addition, then an arithmetic holding is generated
and because of the doubly linked list it rotates the next, in weight digit, once. The opposite thing happens when a subtraction is happening.

## Getting Started ##
## 🎬 Getting Started ##
All you need is at least <strong>GO 1.15</strong>
## Usage ##
## 🤓 Usage ##
Get the package
```bash
go get github.com/slysterous/numeral
Expand All @@ -127,17 +116,17 @@ strnumber:=number2.String()
//will give you the decimal integer representation of the number.
intnumber:=number.Decimal()
```
### Make Utilities
### ⛩️ Make Utilities
```bash
ci run ci
fmt gofmt all files excluding vendor
lint perform linting
test run tests
```
## Contributing ##
## ℹ️ Contributing ##
Refer to [Contributing](https://github.com/slysterous/numeral/blob/main/CONTRIBUTING.md).
## Report bugs using Github's [issues](https://github.com/slysterous/numeral/issues)
## 🐛 Report bugs using Github's [issues](https://github.com/slysterous/numeral/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/slysterous/numeral/issues);
## License ##
## ⚖️ License ##
This library is distributed under the MIT license found in the [LICENSE](./LICENSE)
file.

0 comments on commit b125cb6

Please sign in to comment.