breadkit-render 0.1.0 → 0.2.0

data/site/index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="theme-color" content="#101719">
-    <meta name="description" content="Generate layered SVG, PNG, and JPEG breadboard diagrams from Breadkit circuit files.">
+    <meta name="description" content="Generate interactive SVG, HTML, PDF, and animated breadboard diagrams from Breadkit circuit files.">
     <title>breadkit-render | Turn wiring into a clear diagram</title>
     <link rel="canonical" href="https://breadkit.github.io/breadkit-render/">
     <link rel="icon" href="./favicon.svg" type="image/svg+xml">
@@ -30,16 +30,17 @@
         <div class="max-w-xl">
           <p class="mb-5 text-sm font-medium text-copper">The Breadkit diagram generator</p>
           <h1 class="text-balance text-4xl font-semibold leading-tight sm:text-5xl lg:text-6xl">Turn wiring into a clear diagram.</h1>
-          <p class="mt-6 max-w-lg text-pretty text-lg leading-8 text-muted">Generate a breadboard diagram from components and wires written in Ruby. Switch layers in SVG, or save the result as PNG or JPEG.</p>
+          <p class="mt-6 max-w-lg text-pretty text-lg leading-8 text-muted">Generate a breadboard diagram from components and wires written in Ruby. Explore layers in SVG and HTML, or export images, PDF, and assembly animations.</p>
           <div class="mt-8 flex flex-wrap gap-x-6 gap-y-4">
             <a class="rounded-sm bg-copper px-5 py-3 font-semibold text-ink hover:bg-paper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="./images/sensor-demo.svg">Open example SVG</a>
             <a class="rounded-sm py-3 font-medium text-paper underline decoration-line underline-offset-4 hover:decoration-copper focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-copper" href="https://github.com/breadkit/breadkit/blob/main/examples/05_sensor_demo.bk.rb">View circuit source</a>
           </div>
           <div class="mt-10 rounded-lg border border-line bg-board p-5">
-            <p class="mb-3 text-sm text-muted">Install and render</p>
+            <p class="mb-3 text-sm text-muted">Install the latest published release</p>
             <pre class="overflow-x-auto font-mono text-sm leading-7"><code>gem install breadkit-render
 bkrender circuit.bk.rb -o circuit.svg
 bkrender circuit.bk.rb -o circuit.png --scale 2</code></pre>
+            <p class="mt-4 text-pretty text-sm leading-6 text-muted">These examples follow main. If they are ahead of the published gem, follow the <a class="text-paper underline decoration-line underline-offset-4 hover:decoration-copper" href="https://github.com/breadkit/breadkit-render#quick-start">source checkout setup</a>.</p>
           </div>
         </div>
         <figure class="m-0 overflow-hidden rounded-xl border border-line bg-board">
@@ -56,6 +57,7 @@ bkrender circuit.bk.rb -o circuit.png --scale 2</code></pre>
             <div class="border-t border-line py-6 md:border-l md:border-t-0 md:px-8"><h3 class="text-balance text-xl font-semibold">PNG</h3><p class="mt-3 text-pretty leading-7 text-muted">Useful for READMEs and sharing. Set the resolution with <code class="font-mono text-paper">--scale</code>.</p></div>
             <div class="border-t border-line py-6 md:border-l md:border-t-0 md:pl-8"><h3 class="text-balance text-xl font-semibold">JPEG</h3><p class="mt-3 text-pretty leading-7 text-muted">Save a raster image with a chosen background color and quality.</p></div>
           </div>
+          <p class="mt-6 text-pretty leading-7 text-muted">Need a walkthrough? <code class="font-mono text-paper">bkrender circuit.bk.rb --animate steps -o assembly.apng</code> combines numbered assembly steps into one looping image. Use <code class="font-mono text-paper">--animate states</code> to show switch states.</p>
         </div>
       </section>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breadkit-render
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -15,16 +15,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
-description: bkrender converts breadboard wiring described with the Breadkit DSL into
-  deterministic diagrams.
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: bkrender converts Breadkit circuit files into deterministic breadboard
+  diagrams, animations, and assembly guides.
 email:
 - t.yudai92@gmail.com
 executables:
@@ -32,20 +46,32 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yamllint"
 - CHANGELOG.md
+- Dockerfile
+- Dockerfile.dockerignore
 - LICENSE.txt
 - README.md
 - SECURITY.md
-- docs/images/sensor-demo.png
-- docs/images/sensor-demo.svg
+- docs/REFERENCE.md
+- docs/images/led-netlist.png
+- docs/images/led-schematic.png
 - exe/bkrender
 - lib/breadkit/render.rb
+- lib/breadkit/render/apng_encoder.rb
 - lib/breadkit/render/cli.rb
+- lib/breadkit/render/netlist_renderer.rb
+- lib/breadkit/render/orthogonal_router.rb
 - lib/breadkit/render/rasterizer.rb
+- lib/breadkit/render/schematic_renderer.rb
+- lib/breadkit/render/state_selection.rb
 - lib/breadkit/render/svg_renderer.rb
+- lib/breadkit/render/svg_template.rb
+- lib/breadkit/render/theme.rb
 - lib/breadkit/render/version.rb
 - package-lock.json
 - package.json
+- scripts/check-contrast.mjs
 - sig/breadkit/render.rbs
 - site/favicon.svg
 - site/images/sensor-demo.png
@@ -59,7 +85,7 @@ metadata:
   homepage_uri: https://github.com/breadkit/breadkit-render
   source_code_uri: https://github.com/breadkit/breadkit-render/tree/main
   bug_tracker_uri: https://github.com/breadkit/breadkit-render/issues
-  documentation_uri: https://github.com/breadkit/breadkit-render/tree/main
+  documentation_uri: https://breadkit.github.io/breadkit-render/
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -75,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
-summary: Render Breadkit circuits as SVG, PNG, and JPEG diagrams.
+summary: Render Breadkit circuits as SVG, raster, PDF, and HTML diagrams.
 test_files: []