Skip to content

Add Benchmark menu item and Rust Doc link #242

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.

Sign up for GitHub

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

Draft
doubleailes wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add Benchmark menu item and Rust Doc link #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/content/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ section = "docs"
url = "/docs/getting-started/introduction/"
weight = 10

[[extra.menu.main]]
name = "Benchmark"
section = "benchmark"
url = "/criterion/report/"
weight = 20

[[extra.list]]
title = "Inspiration"
content = 'Inspire by the standard industry <b>rvls</b> command line from Autodesk© (♥ Tweak team)'
Expand All @@ -30,4 +36,8 @@ content = '<b>fls</b> is made to be really fast. 5x time faster than any others'
title = "🦀"
content = '<b>framels</b> is made with pure rust lib which is helping the compatibility with all OS'

[[extra.list]]
title = "Rust Doc"
content = 'All the documentation is available on <a href="https://docs.rs/framels" target="_blank">docs.rs</a>'

+++
40 changes: 40 additions & 0 deletions docs/content/docs/advanced/arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,43 @@ $ fls -t -r .\samples\
┗ aaa.***.tif@1-5
┗ foo_bar.exr
```

### Multithread

You can use a multithread approch of the directory and sub-folder. **framels**
is using the [rayon.rs](https://docs.rs/rayon) lib to do that. The performance
can depends of your CPU frequency and the number of core. See the benchmark.

Starting to 4 core and more than 100 entries, the performance is better than
the standard approche.

You can use `-m` or `--multithread`

Run `fls -m /path/of/directory/` to list a specific directory and his
subfolder

```bash
$ fls -m .\samples\big
RenderPass_Beauty_1_*****.exr@0-96
RenderPass_Occlusion_1_*****.exr@0-73,75-96
RenderPass_Id_1_*****.exr@0-96
RenderPass_Occlusion_1_***.exr@74
RenderPass_Ncam_1_00042.exr.bkp
RenderPass_SpecularRim_1_*****.exr@0-96
RenderPass_DiffuseKey_1_*****.exr@0-96
RenderPass_Pcam_1_*****.exr@0-96
RenderPass_Reflection_1_*****.exr@0-96
RenderPass_Specular_1_*****.exr@0-96
RenderPass_Diffuse_1_*****.exr@0-96
RenderPass_IndDiffuse_1_*****.exr@0-96
RenderPass_Ncam_1_*****.exr@0-41,43-96
```

### Version

You can use `-v` or `--version` to display the current version of the tool.

```bash
$ fls -v
fls 0.7.0
```