Update project readme instructions.

wabiverse · Apr 13, 2024 · 4cfda76 · 4cfda76
1 parent e95236f
commit 4cfda76
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 9 deletions.
diff --git a/Kraken.usda b/Kraken.usda
@@ -1,6 +1,6 @@
 #usda 1.0
 (
-    doc = "Kraken v1.0.7 | PixarUSD v23.11.34"
+    doc = "Kraken v1.0.7 | PixarUSD v23.11.35"
 )
 
 def Xform "Hello"

diff --git a/Package.resolved b/Package.resolved
@@ -1,5 +1,5 @@
 {
-  "originHash" : "6978d34ca4019560d9da5ef8250080bb5f770f703bf740cce06f1935ba930311",
+  "originHash" : "27b4be194201dd0f1fc1cdcedd77604d56dd31cbcac9ca21f3b5d0eb2cbac27b",
   "pins" : [
     {
       "identity" : "aexml",
@@ -50,8 +50,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/wabiverse/MetaverseKit.git",
       "state" : {
-        "revision" : "b398cc73d87ee19c7145926fe20e23b6a2dc81dc",
-        "version" : "1.7.1"
+        "revision" : "736a3abc651e298576bc3574849b55c500128b16",
+        "version" : "1.7.2"
       }
     },
     {
@@ -95,8 +95,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pvieito/PythonKit.git",
       "state" : {
-        "revision" : "41dd1e76bb31661f59efbc1784e8f60ccc32a9d5",
-        "version" : "0.4.1"
+        "revision" : "6fd4817e33c31a57760e285228ef8f81cd359062",
+        "version" : "0.4.2"
       }
     },
     {
@@ -310,8 +310,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/wabiverse/SwiftUSD.git",
       "state" : {
-        "revision" : "1bae4ae1645de394409209acb483d74afdd2a306",
-        "version" : "23.11.34"
+        "revision" : "e36e2d011a2c8bcc0b8863a3c80757c176017202",
+        "version" : "23.11.35"
       }
     },
     {

diff --git a/Package.swift b/Package.swift
@@ -38,7 +38,7 @@ let package = Package(
 
   // --- 🦄 Package Dependencies. ---
   dependencies: [
-    .package(url: "https://github.com/wabiverse/SwiftUSD.git", from: "23.11.34"),
+    .package(url: "https://github.com/wabiverse/SwiftUSD.git", from: "23.11.35"),
     .package(url: "https://github.com/furby-tm/swift-bundler", from: "2.0.9"),
     .package(url: "https://github.com/stackotter/swift-cross-ui", revision: "f57f7ab")
   ],

diff --git a/README.md b/README.md
@@ -59,6 +59,9 @@
    <div align="left">
       
    ```pwsh
+   git clone https://github.com/wabiverse/Kraken
+   cd Kraken
+
    swift package --disable-sandbox plugin bundler run -p macOS Kraken
    ```
 
@@ -87,6 +90,38 @@
 
 <br/>
 
+### **Development**
+
+  > [!TIP]
+  > We recommend installing the [**bundler**](https://github.com/stackotter/swift-bundler.git) locally by running the following commands in your terminal:
+
+<div align="center">
+
+  <div align="left">
+
+  ```pwsh
+  git clone https://github.com/stackotter/swift-bundler
+  cd swift-bundler
+
+  swift build -c release
+  sudo cp .build/release/swift-bundler /usr/local/bin/
+  ```
+
+  </div>
+
+
+  <div align="left">
+
+  Finally, to run Kraken or any other app (such as your own!) with the bundler installed locally instead, run the following command:
+  ```pwsh
+  swift bundler run
+  ```
+
+  </div>
+
+
+</div>
+
 <hr/>
 
 ###### *We speak in pixel, and we come in peace.*