Add README for the build system module #83


	name: Build

	on: [push]

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Allow one concurrent deployment
	concurrency:
	group: "pages"
	cancel-in-progress: true

	jobs:
	build:

	name: Compile
	runs-on: ubuntu-latest
	steps:
	- name: "Check out the repo"
	uses: actions/checkout@v3
	with:
	submodules: true

	- name: Fix checkout ownership
	run: \|
	# HACK Workaround for bug:
	# https://github.com/actions/runner/issues/2033
	mkdir -p /home/runner/work/_temp/_github_home
	printf "[safe]\n\tdirectory = /github/workspace" \
	> /home/runner/work/_temp/_github_home/.gitconfig

	- uses: actions/setup-python@v4
	with:
	python-version: '3.10'

	- name: Install nimble packages
	run: \|
	pip install .

	- name: Generate STLs
	run: \|
	./generate_static.py

	- name: Generate example docs
	run: \|
	cadorchestrator generate '["NUC10i5FNH", "Raspberry_Pi_4B", "Raspberry_Pi_4B"]'

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v1
	with:
	path: "build/"
	# Deployment job
	deploy:
	if: github.ref == 'refs/heads/master'
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v1

Provide feedback