LIHPC-Computational-Geometry / coupe

the concurrent partitioner
https://LIHPC-Computational-Geometry.github.io/coupe/
Apache License 2.0
12 stars 3 forks source link

docs: rewrite `part-bench` doc #216

Closed SebastienMorais closed 1 year ago

SebastienMorais commented 1 year ago

Seems like part-bench's doc is a straight copy paste from mesh-part.

hhirtz commented 1 year ago

Yes, they share the same man page because usage is very similar. :) The options specific to one of both tools are at the bottom of the OPTIONS section.

FYI, github renders .scd files as markdown files but it's incorrect. To view these files in a proper way I suggest use bash and scdoc:

apt install scdoc
man <(scdoc <tools/doc/part-bench.1.scd)
hhirtz commented 1 year ago

Alternatively, you can read them in a web browser with

scdoc <tools/doc/part-bench.1.scd | groff -mandoc -Thtml >/tmp/part-bench.html
firefox /tmp/part-bench.html