Skip to content

Conversation

@MarkoSagadin
Copy link
Collaborator

Description

This PR adds scripts and documentation for managing electronic projects.

This PR is still work in progress and not considered as complete.

What still needs to be done:

  • Document in doc/development/electronic_projects.md needs to be improved. It is currently missing exact steps that are needed to create a new Altium project and sync it to GitHub.
  • The main README.md file (in the project root) is expected to be the starting point for anyone. We need to think how we can adjust it, make it fit the constrains that Altium imposes on us. The constraint that I have in mind is the fact that we first need to create a new project on the Alitum and only then push it to the GitHub. The checklist assumes that the GitHub project is always created first. Maybe we can add some sentence at the beginning in the style of if you are creating an electronic project, first do some other steps and then return to those?
  • Scripts need to be validated on the the Windows machine. I was testing them on my home Windows PC, but right now I had to change the file endings to unix style, I am not sure if the Git Bash handles/cares about that. Also, I want the print statements in the scripts to make sense, so when testing those make sure that they make sense to you.

It the scope of the testing it probably makes sense to create a dummy Altium project and use the scripts on it, to push it to GitHub.

I would be happy if you can come up with a more complete project creation checklist than I did, then we can review it and think how to include it into the existing project.

After-review steps

  • I will merge PR by myself.

@MarkoSagadin MarkoSagadin requested a review from acegne July 14, 2025 09:01
@github-actions github-actions bot added the pull request Pull request, added automatically by CI. label Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pull request Pull request, added automatically by CI.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants