Skip to content

Commit

Permalink
Added repo url to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@brainandforce
brainandforce committed Jun 10, 2024
1 parent bc83e64 commit 140e93a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
[![Coverage][codecov-img]][codecov-url]
[![Aqua.jl][aqua-img]][aqua-url]

A simple, statically sized multivector (Clifford number) implementation for Julia using graded
representations. This allows for common multivector operations, particularly the various products
of geometric algebra, to be easily implemented with extremely high performance (faster than matrix
multiplications of matrix representations) without depending on any linear algebra library.
Additionally, the multivectors provided by this package can be stored inline in arrays or other data
structures.
[CliffordNumbers.jl][repo-url] is a simple, statically sized multivector (Clifford number)
implementation for Julia using graded representations. This allows for common multivector
operations, particularly the various products of geometric algebra, to be easily implemented with
extremely high performance (faster than matrix multiplications of matrix representations) without
depending on any linear algebra library. Additionally, the multivectors provided by this package can
be stored inline in arrays or other data structures.

# Clifford numbers

Expand Down Expand Up @@ -132,6 +132,7 @@ Note that `AbstractCliffordNumber{Q,T}` is a scalar type, so dotted operators do
operations to each coefficient individually. However, they can be used to perform elementwise
operations on collections of Clifford numbers.

[repo-url]: https://github.com/brainandforce/CliffordNumbers.jl
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://brainandforce.github.io/CliffordNumbers.jl/stable
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
Expand Down

2 comments on commit 140e93a

@brainandforce
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/108677

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.5 -m "<description of version>" 140e93ac6648a05f37fe459313d413c608c91244
git push origin v0.1.5

Please sign in to comment.