From 04c263309cb29e947f10311069279e50d622b2da Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Sun, 23 Jun 2024 20:45:12 +0200 Subject: [PATCH] Update README --- README.md | 107 +++++++++++++++++------------------------------------- 1 file changed, 34 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 8d00c6db..614ea1e5 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,53 @@ -# compas_xr +# COMPAS XR -COMPAS XR streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments. +[![Github Actions Build Status](https://github.com/gramaziokohler/compas_xr/workflows/build/badge.svg)](https://github.com/gramaziokohler/compas_xr/actions) +[![License](https://img.shields.io/github/license/gramaziokohler/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr) +[![pip downloads](https://img.shields.io/pypi/dm/compas_xr)](https://pypi.python.org/project/compas_xr) +[![PyPI Package latest release](https://img.shields.io/pypi/v/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr) +[![Supported implementations](https://img.shields.io/pypi/implementation/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.XXXXXXXX.svg)](https://doi.org/10.5281/zenodo.XXXXXXXX) +[![Twitter Follow](https://img.shields.io/twitter/follow/compas_dev?style=social)](https://twitter.com/compas_dev) +![COMPAS XR](https://raw.githubusercontent.com/gramaziokohler/compas_xr/main/docs/_images/compas_xr_lead_image.png) -## Getting started with this project +`COMPAS XR` streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments. -### Setup code editor +## Installation -1. Open project folder in VS Code -2. Select python environment for the project -3. First time using VS Code and on Windows? Make sure select the correct terminal profile: `Ctrl+Shift+P`, `Terminal: Select Default Profile` and select `Command Prompt`. +> It is recomended you install `compas_xr` inside a virtual environment. -> All terminal commands in the following sections can be run from the VS Code integrated terminal. +```bash +pip install compas_xr +``` +To install `compas_xr` to Rhino run -### First steps with git +```bash +python -m compas_rhino.install +``` -1. Go to the `Source control` tab -2. Make an initial commit with all newly created files +## First Steps +* [Documentation](https://gramaziokohler.github.io/compas_xr/) +* [User guide](https://gramaziokohler.github.io/compas_xr/latest/userguide.html) +* [API Reference](https://gramaziokohler.github.io/compas_xr/latest/api.html) -### First steps with code +## Questions and feedback -1. Install the newly created project +We encourage the use of the [COMPAS framework forum](https://forum.compas-framework.org/) +for questions and discussions. - pip install -e . +## Issue tracker -2. Install it on Rhino +If you found an issue or have a suggestion for a dandy new feature, please file a new issue in our [issue tracker](https://github.com/gramaziokohler/compas_xr/issues). - python -m compas_rhino.install +## Contributing +We love contributions! -### Code conventions +Check the [Contributor's Guide](https://github.com/compas-dev/compas_xr/blob/main/CONTRIBUTING.md) +for more details. -Code convention follows [PEP8](https://pep8.org/) style guidelines and line length of 120 characters. +## Credits -1. Check adherence to style guidelines - - invoke lint - -2. Format code automatically - - invoke format - - -### Documentation - -Documentation is generated automatically out of docstrings and [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) files in this repository - -1. Generate the docs - - invoke docs - -2. Check links in docs are valid - - invoke linkcheck - -3. Open docs in your browser (file explorer -> `dist/docs/index.html`) - - -### Testing - -Tests are written using the [pytest](https://docs.pytest.org/) framework - -1. Run all tests from terminal - - invoke test - -2. Or run them from VS Code from the `Testing` tab - - -### Developing Grasshopper components - -We use [Grasshopper Componentizer](https://github.com/compas-dev/compas-actions.ghpython_components) to develop Python components that can be stored and edited on git. - -1. Build components - - invoke build-ghuser-components - -2. Install components on Rhino - - python -m compas_rhino.install - - -### Publish release - -Releases follow the [semver](https://semver.org/spec/v2.0.0.html) versioning convention. - -1. Create a new release - - invoke release major +`compas_xr` is currently developed by Gramazio Kohler Research at ETH Zurich and Princeton University. See the [list of authors](https://github.com/gramaziokohler/compas_xr/blob/main/AUTHORS.md) for a complete overview.