refactor(README): suggestions

README.md

@@ -70,33 +70,36 @@ mechanics:
       # ...
       - max_participants: 30000
         apr_boost: 0.05
+
     # Redirect rewards to different addresses. The left-hand side is the owner address,
     # and the right-hand side is the reward recipient address. Do not specify deployer
     # addresses on the left-hand side, only owner addresses.
     owner_redirects:
       "0x1234567890abcdef1234567890abcdef12345678": "0x1234567890abcdef1234567890abcdef12345678"
-    # Redirect rewards to different addresses by validator public key. The left-hand side is the validator public key,
-    # and the right-hand side is the reward recipient address.
+
+    # Redirect rewards to different addresses by validator public key. The left-hand side is the validator
+    # public key, and the right-hand side is the reward recipient address.
     validator_redirects:
-       "0x1234500012345000123450001234500012345000123450001234500012345000123450001234500012345000123450001234": "0x1234567890abcdef1234567890abcdef12345678"
-
-    # Alternatively, you can specify redirects using external CSV files:
-    # - You cannot use both `owner_redirects` and `owner_redirects_file` simultaneously. Choose one method.
-    # - You cannot use both `validator_redirects` and `validator_redirects_file` simultaneously. Choose one method.
-    # - Each file must have a header row with "from" and "to" as column names.
-
-    # For owner redirects, the "from" column contains owner addresses, and the "to" column contains recipient addresses.
-    # Example of owner_redirects_file content:
-    # from,to
-    # 0x1234567890abcdef1234567890abcdef12345678,0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef
-    # 0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef,0x1234567890abcdef1234567890abcdef12345678
-    owner_redirects_file: owner_redirects_2023_11.csv
-    # For validator redirects, the "from" column contains validator public keys, and the "to" column contains recipient addresses.
-    # Example of validator_redirects_file content:
-    # from,to
-    # 0x1234500012345000123450001234500012345000123450001234500012345000123450001234500012345000123450001234,0x1234567890abcdef1234567890abcdef12345678
-    # 0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef,0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef
-    validator_redirects_file: validator_redirects_2023_11.csv
+      "0x1234500012345000123450001234500012345000123450001234500012345000123450001234500012345000123450001234": "0x1234567890abcdef1234567890abcdef12345678"
+
+    # Alternatively, you can specify redirects using external CSV files instead, for example:
+    #   owner_redirects_file: owner_redirects_2023_11.csv
+    #   validator_redirects_file: validator_redirects_2023_11.csv
+    #
+    # Example for `owner_redirects_file`:
+    #   from,to
+    #   0x1234567890abcdef1234567890abcdef12345678,0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef
+    #   0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef,0x1234567890abcdef1234567890abcdef12345678
+    #
+    # Example for `validator_redirects_file`:
+    #   from,to
+    #   0x1234500012345000123450001234500012345000123450001234500012345000123450001234500012345000123450001234,0x1234567890abcdef1234567890abcdef12345678
+    #   0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef,0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef
+    #
+    # Notes:
+    #   - Header is required.
+    #   - File redirects are mutually exclusive with inline redirects: only one can be specified.
+    #   - Files are copied to the `inputs` directory during `calc` for preservation and reproducibility.
 
 rounds:
   - period: 2023-07 # Designated period (year-month)