Template

This is a template project for new faebryk projects. It contains a basic structure and some examples/templates to get you started.

Getting started

First press Use this template button on the top of the page. Then clone your new repo locally:

git clone <your repo>
cd <your repo>

Fill in the templates

replace {} and <> placeholders and fill in TODOs in following files:

• README.md (this file)
• pyproject.toml
• remove this header in this file (up until the first "TEMPLATE README START")

Setup your environment

Make sure you have python3.11 installed

python --version

If you can't upgrade to python3.11, you will first need to make sure to have a working venv with python3.11 installed in it. This process will differ per OS.

Make sure you have poetry installed

poetry --version

Option 1: Static faebryk

# inside your repo dir

#optional: pick alternative faebryk version, see poetry doc for more options
poetry add git+https://github.com/faebryk/faebryk.git#<branch>

poetry install
poetry shell # This activates the new venv

Option 2: Editable faebryk

# inside your repo dir
./scripts/setup_local_faebryk.sh [branch]
poetry shell

Test if it works

python src/<project_name>/main.py

TEMPLATE README START

---

{project}

{MiniDescription} - {project}

About

TODO: description This project is build with the open-source EDA faebryk.

What can you do with this project?

TODO

Working with the source files

See here for the instructions on how to install and edit this project.

Building

If you want to build the physical output of this project you can find the build instructions here.

Contributing

If you want to share your alterations, improvements, or add bugfixes to this project, please take a look at the contributing guidelines.

Community Support

Community support is provided via Discord; see the Resources below for details.

Resources

• Source Code: Github#TODO
• Chat: Real-time chat happens in faebryk's Discord Server (chit-chat room for now). Use this Discord Invite to register
• Issues: Issues#TODO