From f42641843448d0f57d8a710ecd56ebbe8cfd03e9 Mon Sep 17 00:00:00 2001 From: Tim Davis Date: Mon, 11 Sep 2023 11:52:13 -0500 Subject: [PATCH 1/4] how to run bikeshed without installing it --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 73211be..675501c 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,12 @@ To render the spec locally: * Install bikeshed (ideally in an isolated environment): `pipx install bikeshed` * Call `bikeshed spec spec/latest/index.bs` +To render the spec online, see [api.csswg.org](https://api.csswg.org/bikeshed/), +or use the following commands: + +``` +cd binsparse-specification/spec/latest +curl https://api.csswg.org/bikeshed/ -F file=@index.bs > index.html +``` + Rendered versions will generated for pull requests. From 6463d45616e088f7a378bbcc1bc8dbe46030c36b Mon Sep 17 00:00:00 2001 From: Benjamin Brock Date: Mon, 11 Sep 2023 13:15:30 -0400 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 675501c..1873242 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Minutes from our meetings are available [here](https://hackmd.io/0qzK4fJlQp-78t0 ## Specification -The working version of the specification can be found under `spec/latest/index.bs`. +The working version of the specification can be found under [`spec/latest/index.bs`](https://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/GraphBLAS/binsparse-specification/main/spec/latest/index.bs). ### Editing From 114dc996bece004347aa27460cdcee98996615e2 Mon Sep 17 00:00:00 2001 From: Benjamin Brock Date: Mon, 11 Sep 2023 13:17:15 -0400 Subject: [PATCH 3/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1873242..4518b2b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Binary Sparse Format Specification This is part of a new effort to create a binary storage format for storing sparse matrices and other sparse data to disk. +[View Latest Spec](https://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/GraphBLAS/binsparse-specification/main/spec/latest/index.bs) + Minutes from our meetings are available [here](https://hackmd.io/0qzK4fJlQp-78t067yiYsA?view) (see also: [previous minutes](minutes)). ## Specification -The working version of the specification can be found under [`spec/latest/index.bs`](https://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/GraphBLAS/binsparse-specification/main/spec/latest/index.bs). +The working version of the specification can be found under `spec/latest/index.bs`. ### Editing From 2978398d3ecbb234f4998688965b12358903b213 Mon Sep 17 00:00:00 2001 From: Benjamin Brock Date: Mon, 11 Sep 2023 13:18:02 -0400 Subject: [PATCH 4/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4518b2b..790e8fc 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Binary Sparse Format Specification This is part of a new effort to create a binary storage format for storing sparse matrices and other sparse data to disk. -[View Latest Spec](https://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/GraphBLAS/binsparse-specification/main/spec/latest/index.bs) - Minutes from our meetings are available [here](https://hackmd.io/0qzK4fJlQp-78t067yiYsA?view) (see also: [previous minutes](minutes)). ## Specification -The working version of the specification can be found under `spec/latest/index.bs`. +[View Latest Spec](https://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/GraphBLAS/binsparse-specification/main/spec/latest/index.bs) ### Editing +The working version of the specification can be found under `spec/latest/index.bs`. + The spec is written in [bikeshed](https://github.com/tabatkins/bikeshed) – a variant of markdown. To render the spec locally: