Skip to content

Commit

Permalink
docs: update readme, remove early stage
Browse files Browse the repository at this point in the history
  • Loading branch information
ngfelixl committed Jun 23, 2020
1 parent 377b263 commit 983bede
Showing 1 changed file with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,38 @@

Extends the JavaScript array with n-dimensional Vector and Matrix math capabilities. Well tested,
controlled error flow, focus on usability. It even is capable of solving systems of linear equations.
This is an early stage, so it might be faced some API changes in the future.

## Table of contents

1. [Installation](#1-installation)
2. [The Vector class](#2-the-vector-class)
1. [Instantiation and filling with values](#21-instatiation-and-filling-with-values)
2. [Data and Dimensions](#22-data-and-dimensions)
3. [Distance](#23-distance)
4. [Invert the vector](#24-invert-the-vector)
5. [Normalization](#25-normalization)
6. [(Signed) angle](#26-signed-angle)
7. [Addition (and subtraction)](#27-addition-and-subtraction)
8. [Multiplication](#28-multiplication)
9. [Rotation](#29-rotation)
3. [The Matrix](#3-the-matrix)
1. [Instantiation and filling](#31-instantiation-and-filling)
2. [Multiplication](#32-multiplication)
3. [Determinant](#33-determinant)
4. [Trace](#34-trace)
5. [Submatrix extraction](#35-submatrix-extraction)
6. [Transpose](#36-transpose)
7. [Solve system of linear equations](#37-system-of-linear-equations)
8. [Diagonal matrices](#38-diagonal-matrices)
4. [2D-Line Segment intersection](#4-2d-line-segment-intersection)
5. [Convex Hull](#5-convex-hull)
6. [Doubly-connected edge list](#6-doubly-connected-edge-list)
7. [Testing](#7-testing)
8. [Roadmap](#8-roadmap)
9. [Contributing](#9-contributing)
10. [Get in touch](#10-get-in-touch)
- [Vector](#vector)
- [Table of contents](#table-of-contents)
- [1 Installation](#1-installation)
- [2 The Vector class](#2-the-vector-class)
- [2.1 Instatiation and filling with values](#21-instatiation-and-filling-with-values)
- [2.2 Data and Dimensions](#22-data-and-dimensions)
- [2.3 Distance](#23-distance)
- [2.4 Invert the vector](#24-invert-the-vector)
- [2.5 Normalization](#25-normalization)
- [2.6 (Signed) angle](#26-signed-angle)
- [2.7 Addition (and Subtraction)](#27-addition-and-subtraction)
- [2.8 Multiplication](#28-multiplication)
- [2.9 Rotation](#29-rotation)
- [3 The Matrix](#3-the-matrix)
- [3.1 Instantiation and filling](#31-instantiation-and-filling)
- [3.2 Multiplication](#32-multiplication)
- [3.3 Determinant](#33-determinant)
- [3.4 Trace](#34-trace)
- [3.5 Submatrix extraction](#35-submatrix-extraction)
- [3.6 Transpose](#36-transpose)
- [3.7 System of linear equations](#37-system-of-linear-equations)
- [3.8 Diagonal matrices](#38-diagonal-matrices)
- [4 2D-line-segment intersection](#4-2d-line-segment-intersection)
- [5 Convex Hull](#5-convex-hull)
- [6 Doubly-connected edge list](#6-doubly-connected-edge-list)
- [7 Testing](#7-testing)
- [8 Roadmap](#8-roadmap)
- [9 Contributing](#9-contributing)
- [10 Get in touch](#10-get-in-touch)

## 1 Installation

Expand Down

0 comments on commit 983bede

Please sign in to comment.