Browse Source

Rename all README files to standard README.* style

Luke Dashjr 13 years ago
parent
commit
d7dd362ae2
9 changed files with 18 additions and 17 deletions
  1. 1 1
      Makefile.am
  2. 5 5
      README
  3. 0 0
      README.Debian
  4. 0 0
      README.FPGA
  5. 1 1
      README.RPC
  6. 0 0
      README.scrypt
  7. 4 4
      debian/bfgminer.docs
  8. 4 3
      make-release
  9. 3 3
      miner.php

+ 1 - 1
Makefile.am

@@ -4,7 +4,7 @@ ACLOCAL_AMFLAGS = -I m4
 EXTRA_DIST	= example.conf m4/gnulib-cache.m4 linux-usb-bfgminer \
 		  api-example.php miner.php	\
 		  API.class API.java api-example.c windows-build.txt \
-		  bitstreams/* API-README FPGA-README SCRYPT-README
+		  bitstreams/* README.FPGA README.RPC README.scrypt
 
 SUBDIRS		= lib ccan
 

+ 5 - 5
README

@@ -125,7 +125,7 @@ Options for both config file and command line:
                     W: in front of the IP address gives that address privileged access to all api commands
 --api-description   Description placed in the API status header (default: BFGMiner version)
 --api-groups        API one letter groups G:cmd:cmd[,P:cmd:*...]
-                    See API-README for usage
+                    See README.RPC for usage
 --api-listen        Listen for API requests (default: disabled)
                     By default any command that does not just display data returns access denied
                     See --api-allow to overcome this
@@ -216,12 +216,12 @@ GPU only options:
 --worksize|-w <arg> Override detected optimal worksize - one value or comma separated list
 
 
-SCRYPT only options:
+scrypt only options:
 
 --lookup-gap <arg>  Set GPU lookup gap for scrypt mining, comma separated
 --thread-concurrency <arg> Set GPU thread concurrency for scrypt mining, comma separated
 
-See SCRYPT-README for more information regarding (non-bitcoin) scrypt mining.
+See README.scrypt for more information regarding (non-bitcoin) scrypt mining.
 
 
 FPGA mining boards (BitForce, Icarus, ModMiner, X6500, ZTEX) only options:
@@ -256,7 +256,7 @@ prepend the argument with the driver name followed by a colon.
 For example, "icarus:/dev/ttyUSB0" or "bitforce:\\.\COM5"
 or using the short name: "ica:/dev/ttyUSB0" or "bfl:\\.\COM5"
 
-For other FPGA details see the FPGA-README
+For other FPGA details see the README.FPGA
 
 
 CPU only options (not included in binaries):
@@ -724,7 +724,7 @@ BFGMiner shuts down because of this.
 
 RPC API
 
-For RPC API details see the API-README file
+For RPC API details see the README.RPC file
 
 ---
 

+ 0 - 0
README-Debian → README.Debian


+ 0 - 0
FPGA-README → README.FPGA


+ 1 - 1
API-README → README.RPC

@@ -400,7 +400,7 @@ api-example.c - a 'C' program to access the API (with source code)
 
 miner.php - an example web page to access the API
  This includes buttons and inputs to attempt access to the privileged commands
- See the end of this API-README for details of how to tune the display
+ See the end of this README.RPC for details of how to tune the display
  and also to use the option to display a multi-rig summary
 
 ----------

+ 0 - 0
SCRYPT-README → README.scrypt


+ 4 - 4
debian/bfgminer.docs

@@ -1,4 +1,3 @@
-API-README
 API.java
 api-example.c
 api-example.php
@@ -6,9 +5,10 @@ AUTHORS
 ChangeLog
 COPYING
 example.conf
-FPGA-README
 LICENSE
 NEWS
 README
-README-Debian
-SCRYPT-README
+README.Debian
+README.FPGA
+README.RPC
+README.scrypt

+ 4 - 3
make-release

@@ -54,9 +54,10 @@ docs='
 	COPYING
 	NEWS
 	README
-	API-README
-	FPGA-README
-	SCRYPT-README
+	README.Debian
+	README.FPGA
+	README.RPC
+	README.scrypt
 '
 for build in "${builds[@]}"; do
 	PKGNAME="${sw}-${build}"

+ 3 - 3
miner.php

@@ -11,7 +11,7 @@ global $allowcustompages, $customsummarypages;
 global $miner_font_family, $miner_font_size;
 global $colouroverride, $placebuttons, $userlist;
 #
-# See API-README for more details of these variables and how
+# See README.RPC for more details of these variables and how
 # to configure miner.php
 #
 # Web page title
@@ -21,7 +21,7 @@ $title = 'Mine';
 # Set $readonly to false then it will check BFGMiner 'privileged'
 $readonly = false;
 #
-# Set $userlist to null to allow anyone access or read API-README
+# Set $userlist to null to allow anyone access or read README.RPC
 $userlist = null;
 #
 # Set $notify to false to NOT attempt to display the notify command
@@ -77,7 +77,7 @@ $autorefresh = 0;
 $allowcustompages = true;
 #
 # OK this is a bit more complex item: Custom Summary Pages
-# As mentioned above, see API-README
+# As mentioned above, see README.RPC
 # see the example below (if there is no matching data, no total will show)
 $mobilepage = array(
  'DATE' => null,