Added some documentation #189

	name: CI

	on:
	push:
	branches:
	- '**'
	- '!main'

	env:
	CARGO_TERM_COLOR: always

	jobs:
	compile:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions-rs/toolchain@v1
	with:
	toolchain: stable
	- name: Build
	run: cargo build --verbose

	test:
	runs-on: ubuntu-latest
	needs: compile
	steps:
	- uses: actions/checkout@v3
	- uses: actions-rs/toolchain@v1
	with:
	toolchain: stable
	- name: Test
	run: TEST_SETTING=0 cargo test --verbose

	# Push formatting commit even if compilation/testing fails. This does not
	# push a commit if no formatting is required.
	format:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions-rs/toolchain@v1
	with:
	toolchain: stable
	- name: Create Formatting Commit
	uses: mbrobbel/rustfmt-check@master
	with:
	token: ${{ secrets.GITHUB_TOKEN }}

Provide feedback