betterwithage commited on
Commit
42e37a2
·
verified ·
1 Parent(s): a8b4b87

feat(card): P3 polish — add hero, what-is-NOT, how-to-work (doctrine v6)

Browse files
Files changed (1) hide show
  1. README.md +29 -0
README.md CHANGED
@@ -68,6 +68,35 @@ This dataset contains the full source tree of [szl-holdings/amaru](https://githu
68
 
69
  ---
70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  ## ⚖️ License
72
 
73
  Distributed under **Proprietary**. See the [LICENSE](https://github.com/szl-holdings/amaru/blob/main/LICENSE) file in the source repository.
 
68
 
69
  ---
70
 
71
+
72
+ ## How to work it
73
+
74
+ ```bash
75
+ # Download the source snapshot
76
+ hf download SZLHOLDINGS/amaru-source \
77
+ --repo-type dataset \
78
+ --local-dir ./amaru-source
79
+
80
+ # Browse the source tree
81
+ ls ./amaru-source/
82
+ ```
83
+
84
+ ```bash
85
+ # Clone the canonical GitHub source directly
86
+ git clone https://github.com/szl-holdings/amaru
87
+ ```
88
+
89
+ ---
90
+
91
+ ## What this is NOT
92
+
93
+ - **Not a deployable artifact** — this is a source mirror for discoverability; the canonical source is [https://github.com/szl-holdings/amaru](https://github.com/szl-holdings/amaru)
94
+ - **Not training data** — this dataset contains amaru memory attestation source files, not ML training examples
95
+ - **Not a live-updating feed** — the dataset is a point-in-time snapshot at the commit SHA above
96
+ - **Not a complete mirror** — excludes `.git/`, `node_modules/`, and binaries > 50 MB
97
+
98
+ ---
99
+
100
  ## ⚖️ License
101
 
102
  Distributed under **Proprietary**. See the [LICENSE](https://github.com/szl-holdings/amaru/blob/main/LICENSE) file in the source repository.