docs: update build instructions and fix stale doc links (#3559) (#3561)
What the developer wrote
Authored by Seth For Privacy
docs: update build instructions and fix stale doc links (#3559) (#3561)
Replace the README's placeholder build section and the stale
howto-build-android.md reference with links to the current
platform-specific guides in docs/builds/.
Also fix broken links in docs/ADDING_NEW_WALLET_TYPES.md that pointed
to a non-existent adding_new_l2_network_guide.md file and align the
README/docs copyright years with LICENSE.md (2018-2025).
What changed, and why it matters
This commit only updates documentation. It replaces placeholder build instructions in the README with links to current platform-specific guides, fixes two broken links in a developer guide that pointed to a renamed file, and updates copyright years from 2018-2023 to 2018-2025. No code, configuration, or executable files were changed, so there is no security impact.
No security action needed. This is a routine documentation maintenance commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies two Markdown files only. README.md updates the ‘Build Instructions’ section to point to docs/builds/{ANDROID,IOS,LINUX,MACOS,WINDOWS}.md and updates the copyright footer. docs/ADDING_NEW_WALLET_TYPES.md corrects two relative links from ./adding_new_l2_network_guide.md to ./ADDING_EVM_L2_WALLET_NETWORK_TYPES.md and updates the same copyright footer. No source code, build scripts, dependencies, secrets, or permissions are affected.
Changed components
README.mddocs/ADDING_NEW_WALLET_TYPES.mdInspect captured patch +10 / −6
diff --git a/README.md b/README.md
index fa98091c..b1db44a8 100644
--- a/README.md
+++ b/README.md
@@ -116,9 +116,13 @@ We have excellent user guides, which are also open-source and open for contribut
# Build Instructions
-More instructions to follow
+Building Cake Wallet for each platform is covered in the platform-specific guides under `docs/builds/`:
-For instructions on how to build for Android: please view file `howto-build-android.md`
+- [Building for Android](docs/builds/ANDROID.md)
+- [Building for iOS](docs/builds/IOS.md)
+- [Building for Linux](docs/builds/LINUX.md)
+- [Building for macOS](docs/builds/MACOS.md)
+- [Building for Windows](docs/builds/WINDOWS.md)
# Contributing
@@ -186,4 +190,4 @@ The only parts to be translated, if needed, are the values m and s after the var
---
-Copyright (C) 2018-2023 Cake Labs LLC
+Copyright (C) 2018-2025 Cake Labs LLC
diff --git a/docs/ADDING_NEW_WALLET_TYPES.md b/docs/ADDING_NEW_WALLET_TYPES.md
index 4beecba8..dac56e05 100644
--- a/docs/ADDING_NEW_WALLET_TYPES.md
+++ b/docs/ADDING_NEW_WALLET_TYPES.md
@@ -2,7 +2,7 @@
## Important: EVM-Compatible Wallets
-**If you're adding an EVM-compatible wallet (Ethereum, Polygon, Base, Arbitrum, Optimism, etc.)**, please refer to the **[Adding New L2 Network Guide](./adding_new_l2_network_guide.md)** instead. EVM wallets use a unified architecture and don't require the full setup described in this guide.
+**If you're adding an EVM-compatible wallet (Ethereum, Polygon, Base, Arbitrum, Optimism, etc.)**, please refer to the **[Adding New L2 Network Guide](./ADDING_EVM_L2_WALLET_NETWORK_TYPES.md)** instead. EVM wallets use a unified architecture and don't require the full setup described in this guide.
**For EVM wallets:**
- Use `WalletType.evm` (unified type for all EVM chains)
@@ -984,7 +984,7 @@ Add:
dart run build_runner build --delete-conflicting-outputs
```
-4. **EVM Wallets**: If adding an EVM-compatible wallet, use the [L2 Network Guide](./adding_new_l2_network_guide.md) instead.
+4. **EVM Wallets**: If adding an EVM-compatible wallet, use the [L2 Network Guide](./ADDING_EVM_L2_WALLET_NETWORK_TYPES.md) instead.
5. **Token Support**: If your wallet supports tokens (like ERC20, SPL, TRC20):
- Add token checks in `exchange_trade_view_model.dart`
@@ -1029,4 +1029,4 @@ Add:
---
-Copyright (C) 2018-2023 Cake Labs LLC
+Copyright (C) 2018-2025 Cake Labs LLC
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.