rf-touchstone 0.0.0 → 0.0.1

package/coverage/coverage-badge.svg

@@ -1,14 +1,14 @@
 <svg width="103.3" height="20" viewBox="0 0 1033 200" xmlns="http://www.w3.org/2000/svg" role="img" aria-label="coverage: 100%">
   <title>coverage: 100%</title>
-  <linearGradient id="UdZSm" x2="0" y2="100%">
+  <linearGradient id="dSfks" x2="0" y2="100%">
     <stop offset="0" stop-opacity=".1" stop-color="#EEE"/>
     <stop offset="1" stop-opacity=".1"/>
   </linearGradient>
-  <mask id="QwWIL"><rect width="1033" height="200" rx="30" fill="#FFF"/></mask>
-  <g mask="url(#QwWIL)">
+  <mask id="rwmqg"><rect width="1033" height="200" rx="30" fill="#FFF"/></mask>
+  <g mask="url(#rwmqg)">
     <rect width="603" height="200" fill="#555"/>
     <rect width="430" height="200" fill="#49c31a" x="603"/>
-    <rect width="1033" height="200" fill="url(#UdZSm)"/>
+    <rect width="1033" height="200" fill="url(#dSfks)"/>
   </g>
   <g aria-hidden="true" fill="#fff" text-anchor="start" font-family="Verdana,DejaVu Sans,sans-serif" font-size="110">
     <text x="60" y="148" textLength="503" fill="#000" opacity="0.25">coverage</text>

package/development.md

@@ -13,55 +13,76 @@ node -v
 ### Install yarn
 
 ```sh
-npm install --global yarn
+yarn set version stable
 ```
 
-### Install packages
+### Check the current version of yarn
 
 ```sh
-yarn install
+yarn -v
 ```
 
-### Check for outdated packages
+### Install packages
 
 ```sh
-yarn outdated
+yarn
 ```
 
-### Upgrades packages
+### Check for outdated packages, and upgrade packages
 
 ```sh
-yarn upgrade --latest
+yarn upgrade-interactive
 ```
 
 ## Setup Python environment
 
 ### Create and Use Virtual Environments
 
-#### Create a new virtual environment
+#### Install uv
+
+`uv` is a fast Python package installer and virtual environment manager. You can install `uv` by running the following command:
 
 ```sh
-python -m venv .venv
+curl -LsSf https://astral.sh/uv/install.sh | sh
 ```
 
-#### Activate the virtual environment
+#### Add the `uv` executable to your system's PATH
 
-On Windows:
+Source the appropriate environment file for your shell:
 
 ```sh
-.venv\Scripts\activate
+# On Bash, Zsh, or Sh:
+source $HOME/.local/bin/env
+# On Fish:
+source $HOME/.local/bin/env.fish
 ```
 
-On MacOS/Linux
+You may need to restart your shell or open a new terminal session for the changes to take effect.
+
+#### Create and Use Virtual Environments with uv
+
+Create a new virtual environment:
 
 ```sh
+uv venv .venv
+```
+
+#### Activate the virtual environment
+
+```sh
+# On Windows:
+.venv\Scripts\activate
+# On MacOS/Linux:
 source .venv/bin/activate
 ```
 
 #### To confirm the virtual environment is activated, check the location of your Python interpreter:
 
 ```sh
+# On Windows:
 where python
+# On MacOS/Linux:
+which python
 ```
 
 #### Check python version
@@ -70,32 +91,33 @@ where python
 python --version
 ```
 
-#### Deactivate a virtual environment
+#### Install packages using uv
 
-On Windows:
+Install packages using a requirements file:
 
 ```sh
-.venv\Scripts\deactivate
+uv pip install -r requirements.txt
 ```
 
-### Install packages using pip
-
-#### Update pip
+#### Check packages available for update
 
 ```sh
-python -m pip install --upgrade pip
+uv pip list --outdated
 ```
 
-#### Install packages using a requirements file
+#### Upgrade packages
 
 ```sh
-python -m pip install -r requirements.txt
+uv pip install -r requirements.txt --upgrade
 ```
 
-#### Check packages available for update
+#### Deactivate a virtual environment
 
 ```sh
-pip list --outdated
+# On Windows:
+.venv\Scripts\deactivate
+# On MacOS/Linux:
+deactivate
 ```
 
 ## Development
@@ -116,8 +138,10 @@ yarn format
 
 #### Interactive development
 
+Runs the tests in interactive watch mode:
+
 ```sh
-yarn vitest
+yarn test:watch
 ```
 
 #### Command line