Skip to content

Commit e727a23

Browse files
committed
Update readme
1 parent 3c1e90c commit e727a23

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ The result might look something like this (please excuse the lack of 3D renderin
3030
- [Notes](#notes)
3131
- [Installation](#installation)
3232
- [Usage](#usage)
33-
- [Basic usage](#basic-usage)
33+
- [Recommended settings](#recommended-settings)
34+
- [Benchmark example](#benchmark-example)
3435
- [Sequences of files](#sequences-of-files)
3536
- [Input file formats](#input-file-formats)
3637
- [VTK](#vtk)
@@ -187,7 +188,7 @@ Files with the "`.json`" extension are interpreted as serializations of a `Vec<[
187188

188189
## Output file formats
189190

190-
Currently, only VTK files are supported for output.
191+
Currently, only VTK and OBJ formats are supported to store the reconstructed surface meshes.
191192

192193
## All command line options
193194

@@ -285,7 +286,7 @@ OPTIONS:
285286

286287
### The `convert` subcommand
287288

288-
Allows conversion between particle file formats and between mesh file formats. For particles `VTK, BGEO, PLY, XYZ, JSON -> VTK, PLY`
289+
Allows conversion between particle file formats and between mesh file formats. For particles `VTK, BGEO, PLY, XYZ, JSON -> VTK`
289290
is supported. For meshes only `VTK, PLY -> OBJ` is supported.
290291

291292
```

splashsurf/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
99

1010
<p align="center">
11-
<img src="example_particles.png" alt="Image of the original particle data" width="32%"> <img src="example_coarse.png" alt="Image of a coarse reconstructed surface mesh" width="32%"> <img src="example_fine.png" alt="Image of a fine reconstructed surface mesh" width="32%">
11+
<img src="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_particles.png" alt="Image of the original particle data" width="32%"> <img src="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_coarse.png" alt="Image of a coarse reconstructed surface mesh" width="32%"> <img src="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_fine.png" alt="Image of a fine reconstructed surface mesh" width="32%">
1212
</p>
1313

1414
`splashsurf` is a tool to reconstruct surfaces meshes from SPH particle data.
@@ -30,7 +30,8 @@ The result might look something like this (please excuse the lack of 3D renderin
3030
- [Notes](#notes)
3131
- [Installation](#installation)
3232
- [Usage](#usage)
33-
- [Basic usage](#basic-usage)
33+
- [Recommended settings](#recommended-settings)
34+
- [Benchmark example](#benchmark-example)
3435
- [Sequences of files](#sequences-of-files)
3536
- [Input file formats](#input-file-formats)
3637
- [VTK](#vtk)
@@ -187,7 +188,7 @@ Files with the "`.json`" extension are interpreted as serializations of a `Vec<[
187188

188189
## Output file formats
189190

190-
Currently, only VTK files are supported for output.
191+
Currently, only VTK and OBJ formats are supported to store the reconstructed surface meshes.
191192

192193
## All command line options
193194

@@ -285,7 +286,7 @@ OPTIONS:
285286

286287
### The `convert` subcommand
287288

288-
Allows conversion between particle file formats and between mesh file formats. For particles `VTK, BGEO, PLY, XYZ, JSON -> VTK, PLY`
289+
Allows conversion between particle file formats and between mesh file formats. For particles `VTK, BGEO, PLY, XYZ, JSON -> VTK`
289290
is supported. For meshes only `VTK, PLY -> OBJ` is supported.
290291

291292
```

0 commit comments

Comments
 (0)