Skip to content

Commit d173ab9

Browse files
committed
Update readme files
1 parent d381b7d commit d173ab9

3 files changed

Lines changed: 31 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66

77
Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
88

9+
**Contents**
10+
- [The `splashsurf` CLI](#the-splashsurf-cli)
11+
- [Introduction](#introduction)
12+
- [Notes](#notes)
13+
- [Installation](#installation)
14+
- [Usage](#usage)
15+
- [Basic usage](#basic-usage)
16+
- [Sequences of files](#sequences-of-files)
17+
- [Input file formats](#input-file-formats)
18+
- [Ply](#ply)
19+
- [License](#license)
20+
921
# The `splashsurf` CLI
1022

1123
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library parts, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib/README.md) in the `splashsurf_lib` subfolder.

splashsurf/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66

77
Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
88

9+
**Contents**
10+
- [The `splashsurf` CLI](#the-splashsurf-cli)
11+
- [Introduction](#introduction)
12+
- [Notes](#notes)
13+
- [Installation](#installation)
14+
- [Usage](#usage)
15+
- [Basic usage](#basic-usage)
16+
- [Sequences of files](#sequences-of-files)
17+
- [Input file formats](#input-file-formats)
18+
- [Ply](#ply)
19+
- [License](#license)
20+
921
# The `splashsurf` CLI
1022

1123
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library parts, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib/README.md) in the `splashsurf_lib` subfolder.

splashsurf_lib/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@ Library for surface reconstruction of SPH particle data
33

44
The library is mainly used by the `splashsurf` command-line tool which is [also available](https://crates.io/crates/splashsurf) on crates.io.
55

6-
This readme is currently a placeholder that will be extended over time.
7-
For now, check the [GitHub repository](https://github.com/w1th0utnam3/splashsurf) for more information.
6+
For more information about the CLI, check out the [readme in the root of the repository](https://github.com/w1th0utnam3/splashsurf).
7+
8+
**Contents**
9+
- [splashsurf_lib](#splashsurf_lib)
10+
- [Usage](#usage)
11+
- [Feature flags](#feature-flags)
12+
- [The surface reconstruction procedure](#the-surface-reconstruction-procedure)
813

914
## Usage
1015

0 commit comments

Comments
 (0)