initial skeleton

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - boilerplate
+      - dev
+      - idiomatic
+      - master
+      - rc1
+      - rc2
+      - rc3
+  pull_request:
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checking out code
+      uses: actions/checkout@v4
+
+    - name: Build
+      run: cargo build --verbose
+
+    - name: Run tests
+      run: cargo test --verbose
+
+    - name: Publish dry-run
+      run: cargo publish --dry-run

.gitignore

@@ -0,0 +1,24 @@
+# directories (by name)
+
+/_build/
+/_build-ci/
+/scratch/
+/target/
+
+
+# directories (by pattern)
+
+
+# files (by name)
+
+.DS_Store
+
+
+# files (by pattern)
+
+**/*.rs.bk # These are backup files generated by rustfmt
+
+*~
+*.swp
+*.tmp
+*.zip

AUTHORS.md

@@ -0,0 +1,21 @@
+# woad.Rust - Authors <!-- omit in toc -->
+
+
+## Major Contributors
+
+| Name        | GitHub                            |
+| ----------- | --------------------------------- |
+| Matt Wilson | [mwsis](https://github.com/mwsis) |
+
+
+## Defect reports, fixes and suggestions (for which we are very grateful)
+
+| Name    | GitHub |
+| ------- | ------ |
+| \<none> |        |
+
+
+Contributions are welcomed.
+
+
+<!-- ########################### end of file ########################### -->

CHANGES.md

@@ -0,0 +1,9 @@
+# woad.Rust - Changes <!-- omit in toc -->
+
+
+## 0.0.0 - 15th August 2026
+
+* initial project scaffolding;
+
+
+<!-- ########################### end of file ########################### -->

Cargo.toml

@@ -0,0 +1,61 @@
+# ##########################################################
+# Package
+
+[package]
+
+authors = [
+	"Matt Wilson <matthew@synesis.com.au>",
+]
+categories = [
+	"command-line-interface",
+]
+description = "Minimal ANSI terminal colour codes, for Rust"
+edition = "2021"
+homepage = "https://github.com/synesissoftware/woad.Rust"
+keywords = [
+	"ansi",
+	"colour",
+	"sgr",
+	"terminal",
+	"tty",
+]
+license = "BSD-3-Clause"
+name = "woad"
+readme = "README.md"
+repository = "https://github.com/synesissoftware/woad.Rust"
+version = "0.0.0"
+
+
+# ##########################################################
+# Targets
+
+[lib]
+name = "woad"
+path = "src/lib.rs"
+
+
+# ##########################################################
+# Features
+
+[features]
+
+default = [
+]
+
+# General features:
+#
+# - "null-feature" - a feature that has no effect (and, thus, is useful for simplifying driver scripts);
+
+null-feature = []
+
+
+# ##########################################################
+# Dependencies
+
+[dependencies]
+
+
+[dev-dependencies]
+
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

LICENSE

@@ -0,0 +1,30 @@
+woad.Rust - BSD 3-Clause License
+
+Copyright (c) 2026, Matthew Wilson and Synesis Information Systems
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1 +1,92 @@
-# woad.Rust
+# woad.Rust <!-- omit in toc -->
+
+Minimal ANSI terminal colour codes, for Rust
+
+![Language](https://img.shields.io/badge/Rust-000000?style=flat&logo=rust&logoColor=white)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Crates.io](https://img.shields.io/crates/v/woad.svg)](https://crates.io/crates/woad)
+[![GitHub release](https://img.shields.io/github/v/release/synesissoftware/woad.Rust.svg)](https://github.com/synesissoftware/woad.Rust/releases/latest)
+[![Last Commit](https://img.shields.io/github/last-commit/synesissoftware/woad.Rust)](https://github.com/synesissoftware/woad.Rust/commits/master)
+[![CI](https://github.com/synesissoftware/woad.Rust/actions/workflows/ci.yml/badge.svg)](https://github.com/synesissoftware/woad.Rust/actions/workflows/ci.yml)
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Dependencies](#dependencies)
+    - [Efferent (fan-out)](#efferent-fan-out)
+    - [Development Dependencies](#development-dependencies)
+    - [Afferent (fan-in)](#afferent-fan-in)
+  - [Related projects](#related-projects)
+  - [License](#license)
+
+
+## Introduction
+
+**woad** provides the smallest useful set of fixed ANSI SGR colour sequences for library authors. It is not a console or TUI framework.
+
+**woad.Rust** is the **Rust** implementation.
+
+
+## Installation
+
+Reference in **Cargo.toml** in the usual way:
+
+```toml
+woad = { version = "0" }
+```
+
+
+## Components
+
+**woad.Rust** currently ships version metadata (`woad::VERSION`). Colour codes, TTY/stream gating, and Windows virtual-terminal opt-in are not implemented in this 0.0.0 skeleton.
+
+
+## Project Information
+
+
+### Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/woad.Rust "GitHub Page")
+
+
+### Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/woad.Rust.
+
+
+### Dependencies
+
+
+#### Efferent (fan-out)
+
+None.
+
+
+#### Development Dependencies
+
+None.
+
+
+#### Afferent (fan-in)
+
+None (currently).
+
+
+### Related projects
+
+* [**woad.Python**](https://github.com/synesissoftware/woad.Python/)
+* [**woad.Ruby**](https://github.com/synesissoftware/woad.Ruby/)
+
+
+### License
+
+**woad.Rust** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+
+
+<!-- ########################### end of file ########################### -->

TODO.md

@@ -0,0 +1,21 @@
+# woad.Rust - TODO <!-- omit in toc -->
+
+
+## Functional improvements
+
+* [ ] SGR colour and reset codes;
+* [ ] TTY-conditional colour codes (process and per-stream);
+* [ ] Windows virtual-terminal gating (OS build + `GetConsoleMode`);
+
+
+## Performance improvements
+
+* \<none>
+
+
+## Packaging improvements
+
+* \<none>
+
+
+<!-- ########################### end of file ########################### -->

src/lib.rs

@@ -0,0 +1,18 @@
+//! Placeholder crate for **woad**.Rust.
+//!
+//! Colour facilities are not implemented in this 0.0.0 skeleton.
+
+/// Crate version.
+pub const VERSION : &str = "0.0.0";
+
+
+#[cfg(test)]
+mod tests {
+    #![allow(non_snake_case)]
+
+
+    #[test]
+    fn TEST_VERSION() {
+        assert_eq!(crate::VERSION, "0.0.0");
+    }
+}