Skip to content

Commit 1b3c9a0

Browse files
author
CalorieApp Maintainer
committed
docs: remove public run/build instructions and mark deprecated branches
- README: stripped main.py run and Buildozer APK sections; added pre-release execution disclaimer - OFFICIAL_PROJECT_DOCS: removed run/build lines - WALLET_SWITCHING_TRANSACTION_HISTORY_FIXES: replaced direct run command with high-level flow - Added DEPRECATED_BRANCHES.md documenting legacy branches (CalorieAppV11-2, CalorieAppV11-3, chore/repo-hardening) All direct invocation examples removed per pre-release policy.
1 parent 8dd22f1 commit 1b3c9a0

4 files changed

Lines changed: 35 additions & 65 deletions

File tree

README.md

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -141,43 +141,11 @@ Robust connectivity with automatic failover:
141141
### XRPL Response Caching
142142
Lightweight in-memory caching for select XRPL requests (e.g. `ServerInfo`) reduces redundant network calls and stabilizes performance under intermittent connectivity. Cache entries automatically expire after a short TTL.
143143

144-
## 🚀 Getting Started
144+
## 🚀 Getting Started (Public-Safe)
145145

146-
👉 **See the [Quick Start Guide](docs/QUICK_START.md) for detailed setup instructions.**
146+
> Execution and build instructions are intentionally withheld until a stable, review-approved release milestone. The repository at this stage is for transparency of progress, documentation, and ongoing refactor history — not for end-user execution or distribution.
147147
148-
### Prerequisites
149-
- Python 3.12+
150-
- pip package manager
151-
152-
### Installation
153-
154-
1. **Clone the repository:**
155-
```bash
156-
git clone https://github.com/CalorieToken/CalorieAppTestnet.git
157-
cd CalorieAppTestnet
158-
```
159-
160-
2. **Install dependencies:**
161-
```bash
162-
pip install -r requirements.txt
163-
```
164-
165-
3. **Run the application:**
166-
```bash
167-
python main.py
168-
```
169-
170-
### Building APK (Android)
171-
172-
1. **Install Buildozer:**
173-
```bash
174-
pip install buildozer
175-
```
176-
177-
2. **Build APK:**
178-
```bash
179-
buildozer android debug
180-
```
148+
If you are an authorized collaborator and require internal run/build procedures, request access privately (info@calorietoken.net). All prior direct run examples (e.g. `python main.py`, `buildozer android debug`) have been removed to prevent premature usage of unfinished systems.
181149

182150
## 📱 Usage
183151

@@ -259,11 +227,8 @@ Production builds simply omit these variables and the app reverts to automatic b
259227

260228
Breakpoints remain unchanged ensuring cross-platform compatibility; overrides are strictly opt-in for development convenience.
261229

262-
### Debug Overlay
263-
Enable visual debugging of the responsive system with:
264-
```powershell
265-
$env:DEBUG_RESPONSIVE="1"; python main.py
266-
```
230+
### Debug Overlay (Development Only)
231+
Activation mechanics exist but invocation commands are withheld pre-release. Overlay shows breakpoint class, scaling factors, and dimensions when enabled internally.
267232

268233
This displays a small badge in the top-right corner showing:
269234
- Current size class (xs/sm/md/lg/xl)
@@ -296,13 +261,7 @@ See also:
296261
- Material Design 3: https://m3.material.io/
297262

298263
### Manual Testing
299-
The app has been extensively tested with:
300-
- ✅ Navigation flow testing across all screens
301-
- ✅ XRPL connectivity and failover scenarios
302-
- ✅ Wallet creation and import processes
303-
- ✅ Transaction sending and receiving
304-
- ✅ Performance optimization validation
305-
- ✅ Offline mode functionality
264+
Internal test cycles include navigation, XRPL connectivity/failover simulation, wallet creation/import flows, transaction lifecycle validation, performance sampling, and offline mode handling. Detailed invocation steps are withheld until stable release.
306265

307266
## 🤝 Contributing
308267

docs/DEPRECATED_BRANCHES.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Deprecated Branches
2+
3+
The following branches are now marked as DEPRECATED and should not be used for new work. They are retained temporarily for historical reference and may be deleted after archival.
4+
5+
| Branch | Status | Replacement |
6+
|--------|--------|-------------|
7+
| `chore/repo-hardening` | Deprecated (merged) | `main` |
8+
| `CalorieAppV11-2` | Deprecated (legacy iteration) | `main` |
9+
| `CalorieAppV11-3` | Deprecated (legacy iteration) | `main` |
10+
11+
Active development branches:
12+
- `main` (canonical)
13+
- `feature/visual-refinement-v1.1.2` (current visual + social asset refinements)
14+
15+
Policy:
16+
- No new commits should land on deprecated branches.
17+
- Open PRs (if any) should be closed or retargeted to `main`.
18+
- Automated tooling and CI should ignore deprecated branches.
19+
20+
For questions regarding archival or branch recovery, contact: info@calorietoken.net
21+
22+
Last updated: 2025-11-19

docs/OFFICIAL_PROJECT_DOCS.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@ CalorieApp is a mobile-first wallet and food tracking application integrated wit
2424
- Food tracking features
2525
- Automated UX Tour (public-safe overview)
2626

27-
## Getting Started
27+
## Getting Started (Public-Safe)
2828

29-
- Quick Start: `docs/QUICK_START.md`
30-
- Run: `python main.py`
31-
- Android builds: `buildozer android debug`
29+
Execution and packaging instructions are intentionally withheld while in active Beta. Prior run/build examples removed to discourage use of unfinished components.
3230

3331
## Key Documents
3432

docs/WALLET_SWITCHING_TRANSACTION_HISTORY_FIXES.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,11 @@
6969

7070
## 🎯 **Testing Instructions**
7171

72-
### **Test Wallet Switching**
73-
1. ✅ Start the application: `python main.py`
74-
2. ✅ Navigate to the wallet screen
75-
3. ✅ Click the wallet dropdown menu
76-
4. ✅ Switch between available wallets (2 and 3)
77-
5. ✅ Verify no nonce errors appear
78-
79-
### **Test Transaction History**
80-
1. ✅ Select a funded wallet (like the one from Ripple Altnet faucet)
81-
2. ✅ Check terminal output for debug messages:
82-
- `🔍 Requesting transaction history for: [address]`
83-
- `📡 Transaction history response status: SUCCESS`
84-
- `✅ Found X transactions!` or `ℹ️ No transactions found`
85-
3. ✅ Look for transaction details in the app interface
72+
### **Test Wallet Switching (Procedure Withheld)**
73+
Runtime invocation commands removed. High-level flow: start app, navigate wallet screen, switch wallets, confirm absence of nonce warnings.
74+
75+
### **Test Transaction History (Procedure Withheld)**
76+
Select funded wallet, observe debug output (messages listed below), verify UI reflects transaction presence or absence.
8677

8778
### **Create New Wallet Test**
8879
1. ✅ Use "Create Extra Wallet" or "Create Wallet" features

0 commit comments

Comments
 (0)