Skip to content

Commit

Permalink
Merge pull request #63 from Carifio24/setup-description
Browse files Browse the repository at this point in the history
Use README for package description
  • Loading branch information
Carifio24 authored Sep 21, 2024
2 parents b70314a + d0ce603 commit 543ba63
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@ file formats include [glTF/glB](https://www.khronos.org/gltf/) and [USD](https:/

## Installation

This package is not (yet) listed on PyPI, so to install you'll need to clone this repository and install from source.
This package is pip-installable:

```
git clone https://github.com/Carifio24/glue-ar
cd glue-ar
pip install . # Use `pip install -e .` to install in editable mode
pip install glue-ar
```

Installation requires Node.js to be installed on your system, as we currently use JavaScript packages for performing
Expand Down
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -727,10 +727,15 @@ def data_files(root_directory):
)
cmdclass["js-content"] = js_content_command

with open("README.md", 'r') as f:
description = f.read()

# TODO: Add the rest of the package data
setup_args = dict(
name=name,
cmdclass=cmdclass,
long_description=description,
long_description_content_type="text/markdown",
python_requires=">=3.9",
zip_safe=False,
packages=find_packages(name, exclude=["js"]),
Expand Down

0 comments on commit 543ba63

Please sign in to comment.