rf-touchstone 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 panz2018
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/coverage/coverage-badge.svg

@@ -0,0 +1,20 @@
+<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%">
+    <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)">
+    <rect width="603" height="200" fill="#555"/>
+    <rect width="430" height="200" fill="#49c31a" x="603"/>
+    <rect width="1033" height="200" fill="url(#UdZSm)"/>
+  </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>
+    <text x="50" y="138" textLength="503">coverage</text>
+    <text x="658" y="148" textLength="330" fill="#000" opacity="0.25">100%</text>
+    <text x="648" y="138" textLength="330">100%</text>
+  </g>
+  
+</svg>

package/development.md

@@ -0,0 +1,181 @@
+# Development for RF Touchstone
+
+## Setup Node.js environment
+
+### Download and install [Node.js](https://nodejs.org/en/download/package-manager) from the official website
+
+### Check the current version of Node.js
+
+```sh
+node -v
+```
+
+### Install yarn
+
+```sh
+npm install --global yarn
+```
+
+### Install packages
+
+```sh
+yarn install
+```
+
+### Check for outdated packages
+
+```sh
+yarn outdated
+```
+
+### Upgrades packages
+
+```sh
+yarn upgrade --latest
+```
+
+## Setup Python environment
+
+### Create and Use Virtual Environments
+
+#### Create a new virtual environment
+
+```sh
+python -m venv .venv
+```
+
+#### Activate the virtual environment
+
+On Windows:
+
+```sh
+.venv\Scripts\activate
+```
+
+On MacOS/Linux
+
+```sh
+source .venv/bin/activate
+```
+
+#### To confirm the virtual environment is activated, check the location of your Python interpreter:
+
+```sh
+where python
+```
+
+#### Check python version
+
+```sh
+python --version
+```
+
+#### Deactivate a virtual environment
+
+On Windows:
+
+```sh
+.venv\Scripts\deactivate
+```
+
+### Install packages using pip
+
+#### Update pip
+
+```sh
+python -m pip install --upgrade pip
+```
+
+#### Install packages using a requirements file
+
+```sh
+python -m pip install -r requirements.txt
+```
+
+#### Check packages available for update
+
+```sh
+pip list --outdated
+```
+
+## Development
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+yarn lint
+```
+
+### Format with [Prettier](https://prettier.io/)
+
+```sh
+yarn format
+```
+
+### Unit test with [Vitest](https://vitest.dev/)
+
+#### Interactive development
+
+```sh
+yarn vitest
+```
+
+#### Command line
+
+```sh
+yarn test:unit
+```
+
+#### Check test coverage
+
+```sh
+yarn test:coverage
+```
+
+### All tests
+
+Convenient command includes: lint, format, unit:test, test:coverage, build, and generate API docs
+
+```sh
+yarn test
+```
+
+### Compile, build and minify for production
+
+```sh
+yarn build
+```
+
+### Documentation (using [VitePress](https://vitepress.dev/) and [TypeDoc](https://typedoc.org/))
+
+#### Generate API documentation from TSDoc comments
+
+This command uses TypeDoc to parse TSDoc comments in the TypeScript source files and generates markdown files in the `docs/api` directory.
+
+```sh
+yarn docs:md
+```
+
+#### Start local development server for documentation
+
+This command starts the VitePress development server. You can view your documentation site locally, usually at `http://localhost:5173`.
+
+```sh
+yarn docs:dev
+```
+
+#### Build documentation for deployment
+
+This command builds the static HTML, CSS, and JavaScript files for the documentation site. The output will be in the `docs/.vitepress/dist` directory.
+
+```sh
+yarn docs:build
+```
+
+#### Preview the built documentation locally
+
+After building the documentation, this command allows you to preview the production build locally before deploying it.
+
+```sh
+yarn docs:preview
+```