Free Motion Capture for Everyone πβ¨
TypeScript
add branch specific install/run instructions
jonmatthisb693dfe151a4
diff --git a/README.md b/README.mdindex 54635326..a40b52b3 100644--- a/README.md+++ b/README.md@@ -1,3 +1,45 @@++# SPECIAL INSTRUCTIONS FOR THE `jon/development` BRANCH++## Installation+### Python server+0. Install `uv`+ - https://github.com/astral-sh/uv?tab=readme-ov-file#installation+1. clone the repo+ - `git clone https://github.com/freemocap/freemocap`+2. Change directory to the repo:+ - `cd freemocap`+3. **Change to the `jon/development` branch:**+ - `git switch jon/development`+4. Create virtual environment:+ - `uv venv`+5. Activate virtual environment+ - Windows: `.venv/bin/activate`+ - Mac/Linux: `source .venv/bin/activate`+6. Install dependencies+ - `uv sync`+ -+### React GUI+0. Install Node.js+ - https://nodejs.org/en/download/+1. Change directory to the `freemocap-ui` folder+ - `cd freemocap-ui`+2. Install dependencies+ - `npm install`++## Run the FreeMoCap application in development mode+1. Start the Python Server:+ - `python freemocap/__main__.py`+ - The server should start on `http://localhost:8005`+2. Start the React GUI:+ - `npm run dev`+ - An Electron window should pop up with the FreeMoCap GUI+++# STANDARD README CONTINUES BELOW+___+___+___<p align="center"><img src="https://github.com/freemocap/freemocap/assets/15314521/da1af7fe-f808-43dc-8f59-c579715d6593" height="240" alt="Project Logo"></p>diff --git a/hello.py b/hello.pydeleted file mode 100644index 214b9781..00000000--- a/hello.py+++ /dev/null@@ -1,6 +0,0 @@-def main():- print("Hello from freemocap!")---if __name__ == "__main__":- main()diff --git a/pyproject.toml b/pyproject.tomlindex 352509c9..ba0d945c 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -26,7 +26,7 @@ freemocap-blender-addon = { git = "https://github.com/freemocap/freemocap_blendeskelly-synchronize = { git = "https://github.com/freemocap/skelly_synchronize" }[project.scripts]-skellycam = "freemocap.__main__:main"+freemocap = "freemocap.__main__:main"[tool.uv]package = true\ No newline at end of file