Publish Nerbus source snapshot and build documentation

README.txt

@@ -0,0 +1,69 @@
+NERBUS WALLET 0.2.1
+
+Open nerbus-qt.exe or the Nerbus Wallet desktop shortcut.
+Keep the complete application folder together.
+
+RECEIVING
+Open Receive and click New receiving address. A new wallet is created without
+a password or setup dialog. The private key is generated locally with the NRB core cryptographic
+code and saved before the receiving address is displayed. Address creation
+does not require a daemon, network connection, blockchain download, or Sapling
+parameter files. No address-created confirmation dialog is shown.
+
+KEYS AND BACKUPS
+The default wallet file on Windows is:
+  %APPDATA%\Nerbus\Wallet\wallet.nrb
+Password protection is optional and off by default. A wallet without a password
+opens automatically, does not lock after inactivity, and stores private keys in
+an unencrypted file. Its backups also contain unencrypted private keys.
+
+Use Wallet & backup > Set password (optional) to enable Argon2id13 (3 passes,
+64 MiB) and XChaCha20-Poly1305 encryption. A password-protected wallet locks
+after 10 minutes without keyboard or mouse activity. Use Remove password to
+turn protection off while keeping all addresses and keys. For an existing
+locked wallet, enter its current password once to remove protection.
+Changing protection does not modify existing backup files.
+
+Use Wallet & backup > Back up wallet after creating or importing
+addresses. This is a non-deterministic key wallet: an older backup does not
+contain addresses created later. Keep the backup safe and retain its password
+if it was encrypted. There is no password reset or server-side key recovery.
+
+Restore a .nrb backup before creating a new wallet, or launch with
+--wallet-dir=<new folder> to restore into a separate location. Existing wallets
+are never overwritten by Restore. Only encrypted backups require a password.
+Private keys can also be imported/exported
+in NRB WIF format through Wallet & backup.
+
+Existing daemon wallet.dat files and the old %APPDATA%\Nerbus\NRB directory are
+not modified or automatically migrated. A new wallet has different addresses.
+To use a previous transparent address, import its private key from the original
+wallet. Keep original wallet backups until migration is complete.
+
+NETWORK
+Balance, recent transaction IDs, spendable outputs, and broadcasting use:
+  https://explorer.nerbus.com/wallet/v1
+The server receives public addresses and signed transactions only. Signing is
+performed locally by nerbus-wallet-core. The client verifies the NRB genesis
+identity, previous transaction hashes and output values, key ownership, change
+ownership, and all payment signatures before submission.
+
+This is a lightweight wallet: chain data comes from the configured server;
+it does not independently validate the full blockchain. Transparent standard
+P2PKH addresses are supported. Shielded transfers, staking, identities, and
+multisignature outputs are not supported by this interface.
+
+When the server node is stopped or still syncing, addresses and backups remain
+available. Balance and payments become available when the server node is ready.
+Coinbase outputs are conservatively held until 150 confirmations. The default
+fee is 0.00010000 NRB and can be changed before reviewing a payment.
+
+Signed payment receipts are saved beside the wallet under payments/. If a
+submission times out, check its transaction ID in the explorer before sending
+again. Receipts contain public transaction data, not private keys.
+
+The application never starts nerbusd. The offline signing component accepts
+one JSON request over an anonymous pipe and exits; it has no RPC listener.
+
+BUILD
+See BUILD.txt. Source is included in source/ in the desktop package.