Moved spirq- family of crates to spq

.github/workflows/rust.yml

@@ -23,10 +23,7 @@ jobs:
         cache-on-failure: true
         workspaces: |
           shader-reflect
-          spirq-as
-          spirq-core
-          spirq-dis
-          spirq-spvasm
+          spirq
 
     - name: Cargo Format
       id: cargo_format
@@ -60,10 +57,3 @@ jobs:
         cargo run -p shader-reflect assets/spirv-spec.frag.spv -o assets/spirv-spec.frag.spv.json
         diff assets/spirv-spec.frag.json assets/spirv-spec.frag.spv.json
         cargo run -p shader-reflect assets/moon.spv -o assets/moon.spv.json --reference-all-resources
-
-    - name: Assemble Disassemble Roundtrip
-      id: cargo_build_and_test
-      run: |
-        cargo run -p spirq-as assets/gallery.frag.spvasm -o assets/gallery.frag.spv
-        cargo run -p spirq-dis assets/gallery.frag.spv -o assets/gallery.frag.spvasm --no-indent
-        echo git diff --exit-code --binary

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## v1.2.0
+
+- Separated `spirq-` family of subcrates to [`spq`](https://github.com/PENGUINLIONG/spq-rs)
+
+
 ## v1.1.2
 
 - Fixed compatibility with `spirv` v0.3. (#130)

Cargo.toml

@@ -1,9 +1,5 @@
 [workspace]
 members = [
     "spirq",
-    "spirq-core",
-    "spirq-spvasm",
-    "spirq-dis",
-    "spirq-as",
     "shader-reflect",
 ]

README.md

@@ -3,25 +3,17 @@
 [![Crate](https://img.shields.io/crates/v/spirq)](https://crates.io/crates/spirq)
 [![Documentation](https://docs.rs/spirq/badge.svg)](https://docs.rs/spirq)
 
-`spirq` is a family of crates to help you process SPIR-V binary and assembly for Vulkan.
+`spirq` is a shader reflection tool to help you process SPIR-V binary and assembly for Vulkan. You can use `spirq` to query host-shader interfaces including descriptor bindings, pipeline inputs and outputs, specialization constants.
 
-| Crate | Purpose |
-|-|-|
-|[spirq](spirq/README.md) [![Crate](https://img.shields.io/crates/v/spirq)](https://crates.io/crates/spirq)| Shader resource reflection, including descriptor bindings, pipeline inputs and outputs, specialization constants. |
-|[spirq-core](spirq-core/README.md) [![Crate](https://img.shields.io/crates/v/spirq-core)](https://crates.io/crates/spirq-core)| Common structures and routines for SPIR-V IR analysis. |
-|[spirq-spvasm](spirq-spvasm/README.md) [![Crate](https://img.shields.io/crates/v/spirq-spvasm)](https://crates.io/crates/spirq-spvasm)| SPIR-V assembler and disassembler. |
+You can also use the commandline (CLI) tool [`shader-reflect`](shader-reflect/README.md) to use `spirq` without programming in Rust.
 
-Commandline (CLI) tools are also provided for general use.
+> Note: `spirq-` family of crates have been moved to [`spq`](https://github.com/PENGUINLIONG/spq-rs).
 
-| Crate | Purpose |
-|-|-|
-|[shader-reflect](shader-reflect/README.md) [![Crate](https://img.shields.io/crates/v/shader-reflect)](https://crates.io/crates/shader-reflect)| Shader resource declaration reflector. |
-|[spirq-dis](spirq-dis/README.md) [![Crate](https://img.shields.io/crates/v/spirq-dis)](https://crates.io/crates/spirq-dis)| SPIR-V disassembler frontend. Drop-in replacement of `spirv-dis`. |
-|[spirq-as](spirq-as/README.md) [![Crate](https://img.shields.io/crates/v/spirq-as)](https://crates.io/crates/spirq-as)| SPIR-V assembler frontend. Drop-in replacement of `spirv-as`. |
+## Usage
 
-## What's different from other crates?
+See [the crate level readme](spirq/README.md) for detail.
 
-A lot of my works stand in an overlapping field of compilers and graphics systems, so I often have to work with weird or even corrupted SPIR-V binaries. Obviously, existing tools like `rspirv` and `spirv-reflect` are not designed for this. I then decided to develop my own toolkit, which is now the spirq family.
+## What's different from other crates?
 
 Compared with spirq, `rspirv` has more strict requirements on SPIR-V physical layout, which makes it impossible to process bad test cases for other projects. `spirv-reflect` is a broadly used reflection tool and it's a wrapper crate of Khronos' official [SPIRV-Reflect](https://github.com/KhronosGroup/SPIRV-Reflect) tool. `SPIRV-Reflect`, however, was developed in pretty early days and it has some legacy bad designs (like a limit of 16 descriptors). [SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Reflect) provides Khronos' official assembler and disassembler, while it's hard to be integrated to other Rust projects.