Make detailed README.md about the project #209

	name: CI

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]

	env:
	RUST_BACKTRACE: 1
	# later
	# RUSTFLAGS: -Dwarnings
	CARGO_TERM_COLOR: always

	rust_nightly: nightly-2022-07-23

	jobs:
	tests-pass:
	name: pass
	runs-on: ubuntu-latest
	needs:
	- test
	- miri
	- clippy
	steps:
	- run: exit 0

	test:
	strategy:
	matrix:
	rust:
	- nightly
	os:
	- ubuntu-latest
	- windows-latest
	- macos-latest
	rustflags:
	- '-C target-cpu=native'
	- '-C target-cpu=native -C target-feature=-avx2'
	features:
	- ''
	runs-on: ${{ matrix.os }}
	steps:
	- uses: actions/checkout@v3
	with:
	submodules: true
	- uses: actions-rs/toolchain@v1
	with:
	toolchain: nightly-2022-08-22
	override: true
	- name: Run tests
	run: cargo test ${{ matrix.features }} --release -- --nocapture

	clippy:
	name: clippy
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	with:
	submodules: true
	- name: Install Rust clippy
	uses: actions-rs/toolchain@v1
	with:
	toolchain: nightly-2022-08-22
	override: true
	components: clippy
	- uses: Swatinem/rust-cache@v1
	- name: "clippy --all"
	run: cargo clippy --all --tests --all-features

	miri:
	runs-on: ubuntu-latest
	# Allow miri to fail without blocking CI since it has infrastructure compatibility issues
	# with newer Rust versions and xargo dependencies
	continue-on-error: true
	steps:
	- uses: actions/checkout@v3
	with:
	submodules: true
	- uses: actions-rs/toolchain@v1
	with:
	toolchain: nightly-2022-08-22
	- name: Run miri
	run: \|
	cd ci
	chmod +x miri.sh
	./miri.sh

Provide feedback