search

ProjectPhysX / FluidX3D

The fastest and most memory efficient lattice Boltzmann CFD software, running on all GPUs via OpenCL. Free for non-commercial use.
https://youtube.com/@ProjectPhysX
Other
3.81k stars 301 forks source link

Transition from shell script to Makefile. Include Build and benchmark Android, Linux and MacOS options. Create Contributors.MD #31

Closed FCLC closed 1 year ago

FCLC commented 1 year ago

Also provide options for clean and benchmark directly without recompiling.

Instead of a bash/shell script, it may be best to transition to a proper Makefile

On running make, the default option is to print the help which reads:

Welcome to FluidX3D! \n\nTo get started run 'make' with any of the options: '[linux,mac,android]' depending on your platform. \nIf you'd like to benchmark your OpenCL devices, you may either run 'make [benchmark]' after having run make for your desired plaform or run 'make [platform] benchmark' to do both at once. \n\nIf a device ID is provided by passing 'device=[device ID number]' the benchmark will run on the selected device. Otherwise the most powerful device will be auto selected.

Running make [platform] will build for the relevant platform

Benchmark has the same functionality. Benchmark can also be provided with device=[device ID number] to run on a specific device. Otherwise the most "powerful" device is chosen.

Platform and benchmark can be used together. For example, a user could run: make linux benchmark device=1

ProjectPhysX commented 1 year ago

Thanks for the effort! But I won't do pull requests on the repository. Unfortunately there is still no way to disable the pull request menu on GitHub.

Airblader commented 1 year ago

@ProjectPhysX Some common ways to state that contributions are not accepted, in case you want to add any of them: