doc: add simple readme #173

	on:
	push:
	branches:
	- "main"
	pull_request:

	name: Rust Test

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	env:
	RUST_LOG: info
	RUST_BACKTRACE: 1
	RUSTFLAGS: "-D warnings"
	CARGO_TERM_COLOR: always

	jobs:
	check-rustdoc-links:
	name: Check intra-doc links
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions-rust-lang/setup-rust-toolchain@v1
	- shell: bash
	run: >
	./intra-doc-links.bash
	format_and_lint:
	name: Format and Lint
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	submodules: recursive
	- uses: actions-rust-lang/setup-rust-toolchain@v1
	with:
	components: clippy, rustfmt
	- name: Run rustfmt
	uses: actions-rust-lang/rustfmt@v1
	- name: Run clippy
	run: cargo clippy --all-targets --workspace

	test:
	name: Test
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest, macos-latest, windows-latest]
	runs-on: ${{ matrix.os }}
	needs: [format_and_lint]
	steps:
	- name: Checkout source code
	uses: actions/checkout@v4

	- name: Install Rust toolchain
	uses: actions-rust-lang/setup-rust-toolchain@v1
	with:
	components: rustfmt
	cache: false

	- uses: Swatinem/rust-cache@v2

	- name: Install cargo nextest
	uses: taiki-e/install-action@v2
	with:
	tool: cargo-nextest

	- name: Run tests
	run: >
	cargo nextest run --workspace --all-targets

	- name: Run doctests
	run: >
	cargo test --doc

Provide feedback