add readme #51

	name: GitHub Actions CI (AMD)

	# on:
	# push:
	# branches:
	# - main
	# paths:
	# - "src/**"
	# - "test/**"
	# pull_request:
	# branches:
	# - main
	# paths:
	# - "src/**"
	# - "test/**"

	# concurrency:
	# # This causes it to cancel previous in-progress actions on the same PR / branch,
	# group: ${{ github.workflow }}-${{ github.event.pull_request.number \|\| github.ref }}
	# cancel-in-progress: true

	jobs:
	checkstyle:
	runs-on: ubuntu-latest

	steps:
	- name: Checkout code
	uses: actions/checkout@v3

	- name: Set up Python
	uses: actions/setup-python@v3
	with:
	python-version: '3.10'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install flake8 isort black

	- name: Run checkstyle
	run: make checkstyle

	tests:
	runs-on: ubuntu-latest
	needs: [checkstyle]

	steps:
	- name: Checkout code
	uses: actions/checkout@v3

	- name: Set up Python
	uses: actions/setup-python@v3
	with:
	python-version: '3.10'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -e ".[dev]"

	- name: Run tests
	run: \|
	make test
	make test-convergence

Provide feedback