trufflesuite / ganache

:warning: The Truffle Suite is being sunset. For information on ongoing support, migration options and FAQs, visit the Consensys blog. Thank you for all the support over the years.
https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat?utm_source=github&utm_medium=referral&utm_campaign=2023_Sep_truffle-sunset-2023_announcement_
MIT License
2.62k stars 680 forks source link

Document Programmatic Use of Ganache Better #2577

Open MicaiahReid opened 2 years ago

MicaiahReid commented 2 years ago

We don't have any documentation detailing how to use all Ganache options programmatically. Instead, we list the CLI options in detail and say:

The following options are listed for command line use, but can also be used when running Ganache programatically in your project.

However, there are some differences between CLI and programmatic use for particular options*. We should fully document options both for CLI and programmatic use.

*See #2571 and specifically this comment for one instance of these differences.

davidmurdoch commented 1 year ago

Thing could be made clearer specifically for programmatic use:

In ganache, things are given for free (magic):