- Exclude PC software artifacts from project
- Browse files
-
bogdan committed 2 weeks ago
-
1 parent 3e9e546commit fdcef0a
Showing 7 changed files
with
12 additions
and
20 deletions
+1
-0
.gitignore
@@ -10,4 +10,5 @@ DerivedData/ |
||
| 10 | 10 |
build/ |
| 11 | 11 |
|
| 12 | 12 |
# Large local research archives kept out of regular git history |
| 13 |
+Documentation/Research Resources/Software/PC Software/*.rar |
|
| 13 | 14 |
Documentation/Research Resources/Software/PC Software/UM24C PC Software V1.3.rar |
+3
-1
Documentation/Research Resources/README.md
@@ -31,7 +31,7 @@ Imported sources can include: |
||
| 31 | 31 |
- `Manuals/` |
| 32 | 32 |
Raw manuals and manual inventory notes. |
| 33 | 33 |
- `Software/` |
| 34 |
- Raw APKs, desktop packages, and notes about retained or intentionally skipped software artifacts. |
|
| 34 |
+ Raw APKs and notes about retained or intentionally skipped software artifacts. |
|
| 35 | 35 |
- `Vendor Contacts/` |
| 36 | 36 |
Vendor contact documents and extracted contact details. |
| 37 | 37 |
- `Specifications/` |
@@ -47,11 +47,13 @@ Keep in git: |
||
| 47 | 47 |
|
| 48 | 48 |
- source manuals that are directly cited by our notes |
| 49 | 49 |
- compact software artifacts that are useful for quick inspection |
| 50 |
+- compact software artifacts that are useful for quick inspection |
|
| 50 | 51 |
- extracted Markdown notes that save future reverse-engineering time |
| 51 | 52 |
- one canonical copy of a duplicated vendor artifact |
| 52 | 53 |
|
| 53 | 54 |
Do not keep in regular git history by default: |
| 54 | 55 |
|
| 55 | 56 |
- very large archives that are expensive to clone and not yet central to active work |
| 57 |
+- desktop software packages that are unlikely to be used in the current app workflow |
|
| 56 | 58 |
- duplicate bundles that do not add new information |
| 57 | 59 |
- generated intermediate files created only during extraction |
+3
-2
Documentation/Research Resources/Software/PC Software/README.md
@@ -17,9 +17,10 @@ This folder contains archived desktop software packages related to RuiDeng USB m |
||
| 17 | 17 |
|
| 18 | 18 |
### `RuiDengUSBMeter_V1.0.0.6.rar` |
| 19 | 19 |
|
| 20 |
-- status: added to repository |
|
| 20 |
+- status: reviewed locally but intentionally not committed to regular git history |
|
| 21 | 21 |
- source: `TC66` archive |
| 22 | 22 |
- SHA-1: `10280f20f6979b4b2ee9468d89d0f9b2dd79d552` |
| 23 | 23 |
- apparent scope: likely `TC66` family desktop software |
| 24 |
-- archive status: preserved as raw artifact; quick archive listing only |
|
| 24 |
+- archive status: preserved locally as raw artifact; quick archive listing only |
|
| 25 | 25 |
- quick findings: archive contains `RuiDengUSBMeter.exe`, x86/x64 drivers, `CH.xaml`, `EN.xaml`, and bundled `.NET Framework 4.6` |
| 26 |
+- retention note: excluded from this repository's normal history because it is not expected to be part of the current app workflow |
|
BIN
Documentation/Research Resources/Software/PC Software/RuiDengUSBMeter_V1.0.0.6.rar
Binary file not shown.
+2
-2
Documentation/Research Resources/Software/README.md
@@ -13,8 +13,7 @@ Current status: |
||
| 13 | 13 |
|
| 14 | 14 |
- Android applications imported from the `UM24` archive |
| 15 | 15 |
- Android application imported from the `TC66` archive |
| 16 |
-- compact `TC66` PC software archive retained in repository |
|
| 17 |
-- large `UM24C` PC software archive inspected locally but intentionally not committed to regular git history because of size |
|
| 16 |
+- PC software archives inspected locally but intentionally excluded from the repository because they are bulky and unlikely to be used by the current app |
|
| 18 | 17 |
- font file from the archive intentionally not imported for now because it does not appear device-specific |
| 19 | 18 |
|
| 20 | 19 |
Working note: |
@@ -27,3 +26,4 @@ Retention note: |
||
| 27 | 26 |
|
| 28 | 27 |
- prefer keeping software artifacts that are small enough to clone comfortably and directly useful for protocol or workflow analysis |
| 29 | 28 |
- keep metadata notes for larger archives even when the archive itself stays out of git |
| 29 |
+- for now, that means Android artifacts stay in-repo, while PC software stays documented but untracked |
|
+2
-2
Documentation/Research Resources/Specifications/TC66 Resource Inventory.md
@@ -7,7 +7,7 @@ This note captures what was directly observed from the archived `TC66` resource |
||
| 7 | 7 |
- `TC66.pdf` |
| 8 | 8 |
- `User Maual for Operation and PC software and APP of TC66(C) Type-c USB PD Trigger Meter 2019.6.5.pdf` |
| 9 | 9 |
- `TC66C_V1.1.6.apk` |
| 10 |
-- `RuiDengUSBMeter_V1.0.0.6.rar` |
|
| 10 |
+- `RuiDengUSBMeter_V1.0.0.6.rar` (reviewed locally, not retained in git) |
|
| 11 | 11 |
|
| 12 | 12 |
## Skipped Duplicate |
| 13 | 13 |
|
@@ -39,5 +39,5 @@ This note captures what was directly observed from the archived `TC66` resource |
||
| 39 | 39 |
|
| 40 | 40 |
- manuals may provide UI, feature, and workflow clues specific to `TC66(C)` |
| 41 | 41 |
- the Android APK is a good candidate for later string extraction or decompilation when we need model-specific labels and behavior hints |
| 42 |
-- the PC software archive may be useful for identifying USB/driver assumptions and desktop-side workflows even before full extraction |
|
| 42 |
+- the PC software archive may still be useful for identifying USB/driver assumptions and desktop-side workflows, but it is intentionally left out of git for now |
|
| 43 | 43 |
- the payload working note `TC66C Transport and Payload Working Note.md` now records how the current app models `TC66C` transport and decoded fields |
+1
-13
USB Meter.xcodeproj/project.pbxproj
@@ -64,12 +64,10 @@ |
||
| 64 | 64 |
1C6B6BAB2A2D4F5100A0B001 /* User_Manual_UM34C.pdf */ = {isa = PBXFileReference; lastKnownFileType = image.pdf; path = User_Manual_UM34C.pdf; sourceTree = "<group>"; };
|
| 65 | 65 |
1C6B6B982A2D4F5100A0B001 /* Software README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
|
| 66 | 66 |
1C6B6B992A2D4F5100A0B001 /* Android Apps README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
|
| 67 |
- 1C6B6B9A2A2D4F5100A0B001 /* PC Software README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
|
|
| 68 | 67 |
1C6B6B9B2A2D4F5100A0B001 /* Vendor Contacts README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
|
| 69 | 68 |
1C6B6B9C2A2D4F5100A0B001 /* UM Meter_V3.0.5.apk */ = {isa = PBXFileReference; lastKnownFileType = file; path = "UM Meter_V3.0.5.apk"; sourceTree = "<group>"; };
|
| 70 | 69 |
1C6B6B9D2A2D4F5100A0B001 /* RuiDeng_V1.0.2.apk */ = {isa = PBXFileReference; lastKnownFileType = file; path = RuiDeng_V1.0.2.apk; sourceTree = "<group>"; };
|
| 71 | 70 |
1C6B6BA72A2D4F5100A0B001 /* TC66C_V1.1.6.apk */ = {isa = PBXFileReference; lastKnownFileType = file; path = TC66C_V1.1.6.apk; sourceTree = "<group>"; };
|
| 72 |
- 1C6B6BA82A2D4F5100A0B001 /* RuiDengUSBMeter_V1.0.0.6.rar */ = {isa = PBXFileReference; lastKnownFileType = file; path = RuiDengUSBMeter_V1.0.0.6.rar; sourceTree = "<group>"; };
|
|
| 73 | 71 |
1C6B6B9F2A2D4F5100A0B001 /* Factory technical support and conctact way .docx */ = {isa = PBXFileReference; lastKnownFileType = file; path = "Factory technical support and conctact way .docx"; sourceTree = "<group>"; };
|
| 74 | 72 |
1C6B6B912A2D4F5100A0B001 /* Specifications README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
|
| 75 | 73 |
1C6B6BA42A2D4F5100A0B001 /* UM24-UM25-UM34 Family Compatibility Note.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = "UM24-UM25-UM34 Family Compatibility Note.md"; sourceTree = "<group>"; };
|
@@ -155,9 +153,9 @@ |
||
| 155 | 153 |
1C6B6B8D2A2D4F5100A0B001 /* Research Resources README.md */, |
| 156 | 154 |
1C6B6B8E2A2D4F5100A0B001 /* Manuals */, |
| 157 | 155 |
1C6B6BA02A2D4F5100A0B001 /* Software */, |
| 158 |
- 1C6B6BA32A2D4F5100A0B001 /* Vendor Contacts */, |
|
| 159 | 156 |
1C6B6B902A2D4F5100A0B001 /* Specifications */, |
| 160 | 157 |
1C6B6B922A2D4F5100A0B001 /* Payload Notes */, |
| 158 |
+ 1C6B6BA32A2D4F5100A0B001 /* Vendor Contacts */, |
|
| 161 | 159 |
); |
| 162 | 160 |
path = "Research Resources"; |
| 163 | 161 |
sourceTree = "<group>"; |
@@ -193,7 +191,6 @@ |
||
| 193 | 191 |
children = ( |
| 194 | 192 |
1C6B6B982A2D4F5100A0B001 /* Software README.md */, |
| 195 | 193 |
1C6B6BA12A2D4F5100A0B001 /* Android Apps */, |
| 196 |
- 1C6B6BA22A2D4F5100A0B001 /* PC Software */, |
|
| 197 | 194 |
); |
| 198 | 195 |
path = Software; |
| 199 | 196 |
sourceTree = "<group>"; |
@@ -209,15 +206,6 @@ |
||
| 209 | 206 |
path = "Android Apps"; |
| 210 | 207 |
sourceTree = "<group>"; |
| 211 | 208 |
}; |
| 212 |
- 1C6B6BA22A2D4F5100A0B001 /* PC Software */ = {
|
|
| 213 |
- isa = PBXGroup; |
|
| 214 |
- children = ( |
|
| 215 |
- 1C6B6B9A2A2D4F5100A0B001 /* PC Software README.md */, |
|
| 216 |
- 1C6B6BA82A2D4F5100A0B001 /* RuiDengUSBMeter_V1.0.0.6.rar */, |
|
| 217 |
- ); |
|
| 218 |
- path = "PC Software"; |
|
| 219 |
- sourceTree = "<group>"; |
|
| 220 |
- }; |
|
| 221 | 209 |
1C6B6BA32A2D4F5100A0B001 /* Vendor Contacts */ = {
|
| 222 | 210 |
isa = PBXGroup; |
| 223 | 211 |
children = ( |