Merge pull request #20 from compas-dev/prep-release

Prep release

Author: gonzalocasas

CHANGELOG.md

@@ -9,11 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added type hints to all public methods and functions
+
 ### Changed
 
+* Update Grasshopper components to build as CPython 3.x components
+* Migrated documentation to Mkdocs format
+
 ### Removed
 
 * Removed Support for IronPython 2.7 support
+* Removes dependency on `compas_fab`
+* Removed Rhino 7 post installation hooks
 
 ## [1.0.0] 2024-06-26
 

CONTRIBUTING.md

@@ -12,7 +12,7 @@ In short, this is how that works.
 3. Install development dependencies:
 
    ```bash
-   pip install -e .[dev]
+   pip install -e ".[dev]"
    ```
 
 4. Make sure all tests pass:
@@ -21,7 +21,7 @@ In short, this is how that works.
    invoke test
    ```
 
-5. Start making your changes to the **master** branch (or branch off of it).
+5. Start making your changes to the **main** branch (or branch off of it).
 6. Make sure all tests still pass:
 
    ```bash

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 ETH Zurich, Princeton University
+Copyright (c) 2023-2026 ETH Zurich, Princeton University
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -14,16 +14,16 @@
 
 ## Installation
 
-> It is recomended you install `compas_xr` inside a virtual environment.
+It is recommended to install `compas_xr` inside a virtual environment. We suggest using [uv](https://docs.astral.sh/uv/) for faster and more reliable dependency management.
 
 ```bash
-pip install compas_xr
+uv pip install compas_xr
 ```
 
-To install `compas_xr` to Rhino run
+To use `compas_xr` in Rhino 8, add the requirements header to your script:
 
-```bash
-python -m compas_rhino.install
+```python
+# r: compas_xr
 ```
 
 ## First Steps

docs/_logo/compas_logo_white_transparent.png

@@ -0,0 +1 @@
+# ::: compas_xr.ghpython

docs/_logo/favicon.ico

@@ -0,0 +1 @@
+# ::: compas_xr.mqtt