Contributing

nwoolls edited this page Nov 20, 2014 · 7 revisions

Contribute to Development

MultiMiner is an Open Source project with a permissive MIT license. Whether helping with features, bugs, or documentation, forking and contributing to MultiMiner is always welcome and encouraged.

The source code for MultiMiner is publicly available and regularly updated. You can download and compile the source code for MultiMiner using any of the following free tools:

Source Code

The source code for MultiMiner is structured in such a way that makes it easy to use and re-use for other projects.

The source on GitHub also includes a simple example that illustrates the basic functionality such as mining and monitoring progress.

//download and install the latest version of BFGMiner
const string executablePath = @"D:\bfgminer\";
const string executableName = "bfgminer.exe";
const string userAgent = "MultiMiner/V3-Example";

//download and install bfgminer from MultiMinerApp.com
List<AvailableMiner> availableMiners = AvailableMiners.GetAvailableMiners(userAgent);
AvailableMiner bfgminer = availableMiners.Single(am => am.Name.Equals(MinerNames.BFGMiner, StringComparison.OrdinalIgnoreCase));

Console.WriteLine("Downloading and installing {0} from {1} to the directory {2}",
    executableName, new Uri(bfgminer.Url).Authority, executablePath);

MinerInstaller.InstallMiner(userAgent, bfgminer, executablePath);

Libraries

Specific examples of re-usable libraries available with MultiMiner include:

These assemblies are Cross-Platform using Mono and testing on Windows, Linux and OS X. They are also compatible with Microsoft .NET 3.5 and up.