GGM3 Initial

.gitignore

@@ -3,11 +3,7 @@
 ##
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
-#Ignore thumbnails created by Windows
-Thumbs.db
-
 # User-specific files
-*.rsuser
 *.suo
 *.user
 *.userosscache
@@ -23,8 +19,6 @@ Thumbs.db
 [Rr]eleases/
 x64/
 x86/
-[Aa][Rr][Mm]/
-[Aa][Rr][Mm]64/
 bld/
 [Bb]in/
 [Oo]bj/
@@ -58,14 +52,15 @@ BenchmarkDotNet.Artifacts/
 project.lock.json
 project.fragment.lock.json
 artifacts/
+**/Properties/launchSettings.json
 
 # StyleCop
 StyleCopReport.xml
 
 # Files built by Visual Studio
 *_i.c
 *_p.c
-*_h.h
+*_i.h
 *.ilk
 *.meta
 *.obj
@@ -82,7 +77,6 @@ StyleCopReport.xml
 *.tlh
 *.tmp
 *.tmp_proj
-*_wpftmp.csproj
 *.log
 *.vspscc
 *.vssscc
@@ -227,15 +221,13 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk
+# Including strong name files can present a security risk 
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
 # Since there are multiple workflows, uncomment next line to ignore bower_components
 # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
 #bower_components/
-# ASP.NET Core default setup: bower directory is configured as wwwroot/lib/ and bower restore is true
-**/wwwroot/lib/
 
 # RIA/Silverlight projects
 Generated_Code/
@@ -299,8 +291,8 @@ paket-files/
 .idea/
 *.sln.iml
 
-# CodeRush personal settings
-.cr/personal
+# CodeRush
+.cr/
 
 # Python Tools for Visual Studio (PTVS)
 __pycache__/
@@ -325,7 +317,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output
+# Azure Stream Analytics local run output 
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -334,8 +326,8 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder
+# MFractors (Xamarin productivity tool) working folder 
 .mfractor/
 
-# Local History for Visual Studio
-.localhistory/
+.dropbox
+desktop.ini

README.md

@@ -1,9 +1,56 @@
 # GGM - open-source Grin GPU miner
 
-**Update: GGM3 with Cuckarood29 support is being tested, will be ready for the hard-fork. New version will include all GrinPro speed optimizations as open-source.**
+**Update: GGM3 is compatible with Cuckarood29 PoW activated in 7/2019**
 
-Miner supports all AMD and NVIDIA 6GB+ cards. 
+Miner supports all AMD and NVIDIA 6GB+ cards for both Linux and Winows (MacOS untested). Up to 60% faster compared to GGM2.
 
 GGM releases collect 1% fee for the Grin Development Fund and 1% fee for further miner development.
 
-General GGM chat https://gitter.im/GrinGoldMiner/community
+If you disable fees or profit from the code in some way, consider donating to:
+
+BTC 37WJeFqsvSSdC9BbJUW96oCqzSe4TeESnF
+
+## How to build
+
+Miner is written entirely in C# using new open-source .NET implementation called Dotnet Core.
+
+Instal dotnet core 2.2 SDK (Linux/Windows/Mac) from https://dotnet.microsoft.com/download
+
+Clone the repository and go to _build forder.
+
+Run `build_win.bat` (Windows) or `build_linux.sh` (Linux). Alternatively, run `build_[OS]_API.bat` to build a miner with remote API support.
+API version can be used with our dashboard project to manage multiple rigs.
+
+Run `run_miner_win.bat` or `run_miner_linux.sh` to start the miner.
+
+*If you wish to build CUDA .ptx intermediate code yourself, install CUDA SDK with compatible compiler and compile the project in Cudacka folder.
+Pre-generated PTX file is already included in the repository so there is no need to pre-compile it yourself.*
+
+## How to run binary releases
+
+Both Winows and Linux builds are self-contained and come with all needed dotnet core libraries, there is no need to install any additional SW.
+
+## Configuration
+
+GPUs should be auto-detected on first launch. Once `config.xml` is created you can edit is to access hidden options:
+
+### Define log level
+
+```xml
+    <FileMinimumLogLevel>INFO</FileMinimumLogLevel>
+    <ConsoleMinimumLogLevel>DEBUG</ConsoleMinimumLogLevel>
+```
+
+If you want to see all the details that are happening in the background, change the configration as above. Possible log level options are DEBUG, INFO, WARNING, ERROR.
+
+### Change CPU load
+
+Locate this line in the config
+
+```xml
+  <CPUOffloadValue>
+    0
+  </CPUOffloadValue>
+```
+
+If you wish to reduce CPU load use small numbers (1..10), if you have a powerful multi-core CPU then you can try higher values like 50..100. Value 0 mean auto-balancer. Automatic setting may not work optimally with either very weak CPUs and/or many fast GPUs on the PC (8 and more Vegas for example).