Initial Home page

Home.md

@@ -0,0 +1,66 @@
+Welcome to the cpuminer-opt wiki!
+
+First draft to add log description. Will be supplimented with examples and
+detauiled descriptions of the logs.
+
+## Usage
+
+
+## Logs
+
+### Colours
+
+Somes logs and fields are colour coded based on their purpose or to highlight important information
+
+* Blue is used to report mnetworking events, primarilly new jobs.
+* Green is used to identify when a share has been accepted.
+* Yellow is used when a share is stale or to warn of a minor error that ay affect perforance.
+* Red is a more serious error and is used when a share is rejected or when performance is affected or
+  cause the miner to exit.
+
+The log reports contain a wealth of data that can be used to report actual miner perforance
+and provide estimates.
+
+### Start up
+
+The startup messages are very important to ensure best performmance. In particular
+the features lists ensure the software is built for the CPU architecture and can
+take advantage of all the algo optimizations.
+
+### New stratum, block job report
+
+This report is issued when a new job is received from the stratum server.
+If the report is also for a new block or a changed stratum difficulty the report
+will include new estimates for the new block or stratum difficulty.
+
+
+### Share submitted report
+
+The main purpose of this report is to timestamp when a share is submitted
+and record the job id for later comparison with the share result.
+
+
+### Share result report
+
+This report is generated when a reply to a submitted share is received.
+
+### Periodic summary report
+
+Generated aproximately every 5 miinutes. It is not precise because it is an opportunistic report.
+It is produced when it is convenient in order to miminize the impact on mining.
+
+The report contains data for the 5 minute interval as well as session statistics.
+
+### CPU temperature and frequency report
+
+Another opportunistic report to avoid interrupting mining operation. In adition
+the frequency of the report is dependent on the current temperature. 
+
+* temp > 80: 30 seconds
+* 70 <= temp <= 80: 1 minute
+* t < 70: 2 minutes
+
+In addition the report will be generated sooner if the current temperature exceeds the previous maximum.
+
+The sampling is approximately every 30 seconds. The reported maximum it the highest sample and
+not represent the actual instantaneous maximim temperature.