Skip to content

Commit 1ced258

Browse files
authored
[doc] add toc to README.md
1 parent 935dbad commit 1ced258

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,20 @@
1515

1616
![Python Module](https://github.com/NeuroJSON/pyiso2mesh/actions/workflows/build_all.yml/badge.svg)
1717

18+
## Table of Contents
19+
- [Introduction](#introduction)
20+
- [How to Install](#how-to-install)
21+
- [Runtime Dependencies](#runtime-dependencies)
22+
- [Build Instructions](#build-instructions)
23+
- [Build Dependencies](#build-dependencies)
24+
- [Build Steps](#build-steps)
25+
- [Run built-in unit-tests](#run-built-in-unit-tests)
26+
- [How to Use](#how-to-use)
27+
- [Iso2Mesh function port status](#iso2mesh-function-port-status)
28+
- [Acknowledgement](#acknowledgement)
29+
30+
## Introduction
31+
1832
Iso2Mesh is a versatile 3D mesh generation toolbox,
1933
originally developed for MATLAB and GNU Octave in 2007.
2034
It is designed for the easy creation of high-quality surface and

0 commit comments

Comments
 (0)