Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updating README/index.md
  • Loading branch information
weinbe58 committed Aug 4, 2025
commit 80d1e1d8b63e9d24debf5e240bdc609d15d35179
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Bloqade-Geometry

# Welcome to Bloqade-Geometry
<!--- TODO: fix links after making repo public --->
Bloqade-Geometry is a collection of tools for transforming and modeling geometric
objects used for defining layouts and operation of neutral atom quantum computers.

Currently the only supported geometry is a grid, but more geometries will be added in
the future. For a full list of features, see the [API Reference](reference/bloqade/geometry/prelude/).

[API Reference](reference/bloqade/geometry/prelude/).

## Installation

```bash
uv add bloqade-geometry
```

See [Installation](install.md) for more details.
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Welcome to Bloqade-Geometry

Bloqade-Geometry is a collection of tools for transforming and modeling geometric objects used for defining layouts and operation of neutral atom quantum computers.
Bloqade-Geometry is a collection of tools for transforming and modeling geometric
objects used for defining layouts and operation of neutral atom quantum computers.

Currently the only supported geometry is a grid, but more geometries will be added in the future. For a full list of features, see the [API Reference](reference/bloqade/geometry/prelude/).
Currently the only supported geometry is a grid, but more geometries will be added in
the future. For a full list of features, see the [API Reference](reference/bloqade/geometry/prelude/).

## Installation

Expand Down
Loading