chore: readme

blockarchitech · Jan 12, 2025 · bb0c5c5 · bb0c5c5
1 parent 1ed240d
commit bb0c5c5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 35 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ dist/
 build/
 node_modules/
 package-lock.json
-.lock-waf*
+.lock-waf*
+pebble-wrapper.sh
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Pebble Typescript
+
+A somewhat foolproof way to write Pebble apps with PebbleKit JS using TypeScript.
+
+## Usage
+
+1. Clone this repository
+2. Open `pebble.py`, and edit `PEBBLE_TOOL_LOCATION` to point to your Pebble Tool location. This can be a wrapper script, or point directly to the `pebble` executable.
+3. Run `npm install`
+4. Write your TypeScript code in `src/pkts/`
+5. Run `npm run build`
+6. Your compiled Pebble app will be in `build/pebble-ts.pbw`
+
+To clean, simply run `npm run clean`. This will delete the webpack caches and run `pebble clean` as to not leave any pebble build artifacts behind.
diff --git a/pebble-wrapper.sh b/pebble-wrapper.sh