atomicfs: add README #9876

	name: PR tests

	on:
	push:
	branches:
	- master
	- crl-release-*
	- pebble-release-*

	pull_request:
	branches:
	- master
	- crl-release-*
	- pebble-release-*

	jobs:

	# This check is required to merge PRs.
	go-linux:
	name: go-linux
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v4
	with:
	go-version: '1.23'

	- run: GOTRACEBACK=all make test testobjiotracing generate

	- name: Assert workspace clean
	run: scripts/check-workspace-clean.sh

	# This check is required to merge PRs.
	go-lint-checks:
	name: go-lint-checks
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v4
	with:
	go-version: '1.23'

	- name: mod-tidy-check
	run: make mod-tidy-check

	- name: format-check
	run: make format-check

	linux-no-invariants:
	name: go-linux-no-invariants
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v4
	with:
	go-version: '1.23'

	- run: GOTRACEBACK=all make test TAGS=

	linux-race:
	name: linux-race
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v4
	with:
	go-version: "1.23"

	- run: GOTRACEBACK=all make testrace TAGS=

	darwin:
	name: go-macos
	runs-on: macos-14
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v4
	with:
	go-version: '1.23'

	- run: GOTRACEBACK=all make test

Provide feedback