Browse Source

Merge branch '201311-doc-updates' into bfgminer

Luke Dashjr 12 years ago
parent
commit
cd2b73cbe4
2 changed files with 14 additions and 11 deletions
  1. 1 0
      AUTHORS
  2. 13 11
      README

+ 1 - 0
AUTHORS

@@ -43,3 +43,4 @@ Raulo <p987341@gmail.com>
 Thorsten Gilling <tgilling@web.de>
 Thorsten Gilling <tgilling@web.de>
 capa66 <capa66@x204.com>
 capa66 <capa66@x204.com>
 Red_Wolf_2 <redwolf@wolfnexus.net>
 Red_Wolf_2 <redwolf@wolfnexus.net>
+Mr O <notanatheist@gmail.com>

+ 13 - 11
README

@@ -67,8 +67,8 @@ If you specify the --socks-proxy option to BFGMiner, it will only be applied to
 all pools that don't specify their own proxy setting like above
 all pools that don't specify their own proxy setting like above
 
 
 
 
-After saving configuration from the menu, you do not need to give BFGMiner any
-arguments, it will load your configuration instead.
+After saving configuration from the menu ([S],[W]) you do not need to give
+BFGMiner any arguments, it will load your configuration instead.
 
 
 Any configuration file may also contain a single
 Any configuration file may also contain a single
 	"include" : "filename"
 	"include" : "filename"
@@ -180,6 +180,8 @@ Native WIN32 build instructions: see windows-build.txt
 If you build BFGMiner from source, it is recommended that you run it from the
 If you build BFGMiner from source, it is recommended that you run it from the
 build directory. On *nix, you will usually need to prepend your command with a
 build directory. On *nix, you will usually need to prepend your command with a
 path like this (if you are in the bfgminer directory already): ./bfgminer
 path like this (if you are in the bfgminer directory already): ./bfgminer
+To install system wide run 'sudo make install' or 'make install' as root. You
+can then run from any terminal.
 
 
 ---
 ---
 
 
@@ -550,22 +552,22 @@ semicolon separated --quota(or -U) entry instead of --url. Pools specified with
 --url are given a nominal quota value of 1 and entries can be mixed.
 --url are given a nominal quota value of 1 and entries can be mixed.
 
 
 For example:
 For example:
---url poola:porta -u usernamea -p passa --quota "2;poolb:portb" -u usernameb -p passb
-Will give poola 1/3 of the work and poolb 2/3 of the work.
+--url poolA:portA -u usernameA -p passA --quota "2;poolB:portB" -u usernameB -p passB
+Will give poolA 1/3 of the work and poolB 2/3 of the work.
 
 
 Writing configuration files with quotas is likewise supported. To use the above
 Writing configuration files with quotas is likewise supported. To use the above
 quotas in a configuration file they would be specified thus:
 quotas in a configuration file they would be specified thus:
 
 
 "pools" : [
 "pools" : [
         {
         {
-                "url" : "poola:porta",
-                "user" : "usernamea",
-                "pass" : "passa"
+                "url" : "poolA:portA",
+                "user" : "usernameA",
+                "pass" : "passA"
         },
         },
         {
         {
-                "quota" : "2;poolb:portb",
-                "user" : "usernameb",
-                "pass" : "passb"
+                "quota" : "2;poolB:portB",
+                "user" : "usernameB",
+                "pass" : "passB"
         }
         }
 ]
 ]
 
 
@@ -667,7 +669,7 @@ A: No such feature has been implemented to support this.
 
 
 Q: Can I put multiple pools in the config file?
 Q: Can I put multiple pools in the config file?
 A: Yes, check the example.conf file. Alternatively, set up everything either on
 A: Yes, check the example.conf file. Alternatively, set up everything either on
-the command line or via the menu after startup and choose settings->write
+the command line or via the menu after startup and choose [S]ettings->[W]rite
 config file and the file will be loaded one each startup.
 config file and the file will be loaded one each startup.
 
 
 Q: The build fails with gcc is unable to build a binary.
 Q: The build fails with gcc is unable to build a binary.