Skip to content

docs: Update README.md #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,6 @@ The fastest and most intuitive library to manipulate STL files (stereolithograph
🌟 :fist_raised: Please consider starring and sponsoring the GitHub repo to show your support! :fist_raised: 🌟
![GitHub Sponsor](https://img.shields.io/github/sponsors/Innoptech?label=Sponsor&logo=GitHub)

## Index
1. **Performance**
- [Performance Benchmark](#performances-benchmark)

2. **Python Usage**
- [Install](#install)
- [Read and Write STL Files](#read-and-write-from-a-stl-file)
- [Rotate, Translate, and Scale Meshes](#rotate-translate-and-scale-a-mesh)
- [Convert Between Triangles and Vertices/Faces](#convert-triangles-arrow_right-vertices-and-faces)
- [Find Connected Components](#find-connected-components-in-mesh-topology-disjoint-solids)
- [Use with PyTorch](#use-with-pytorch)
- [Handling Large STL Files](#read-large-stl-file)

3. **C++ Usage**
- [Read STL from File](#read-stl-from-file)
- [Write STL to File](#write-stl-to-a-file)
- [Serialize STL to Stream](#serialize-stl-to-a-stream)
- [Convert Between Triangles and Vertices/Faces](#convert-triangles-arrow_right-vertices-and-faces-1)
- [Find Connected Components](#find-connected-components-in-mesh-topology)

4. **C++ Integration**
- [Smart Method with CMake](#smart-method)
- [Naïve Method](#naïve-method)

5. **Testing**
- [Run Tests](#test)

6. **Requirements**
- [C++ Standards](#requirements)

7. **Disclaimer**
- [STL File Format Limitations](#disclaimer-stl-file-format)


# Performances benchmark
Discover the staggering performance of OpenSTL in comparison to [numpy-stl](https://github.com/wolph/numpy-stl),
Expand Down
Loading