Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Git repository with the code #11

Open
Hneuschmidt opened this issue Feb 9, 2024 · 0 comments
Open

Create a Git repository with the code #11

Hneuschmidt opened this issue Feb 9, 2024 · 0 comments
Assignees

Comments

@Hneuschmidt
Copy link
Collaborator

Hneuschmidt commented Feb 9, 2024

The code is currently only available as a bundled release. It would be advantageous to have the code be available
also as a git repository.

Concrete advantages of a having repository:

  • The code will be under version control, making it easier to add incremental changes and roll back in cases of bugs
  • It makes it possible to add changes and improvements that are much smaller that what would make sense for a new release
  • Experimental features can be added on a separate branch, without compromising the status of the main project
  • Bug fixes and improvements by third parties can be integrated via pull request if desired

My first step will be to add all the code in its current form to a branch.
For now, I will leave out files that are not text files, which generally do not benefit from being in a git repository.
This specifically includes the compiled version of the matlab part and POV-Ray, example models and the pdf version of the documentation.
These files will still be available through the releases mechanism as is the case right now.
I think the documentation should also live in the repo in a source version that can be compiled by users or hosted somewhere,
but that is a for a separate issue.

In general, I plan to use these issues as a form to communicate what I am working on, so @StefanJAuer can weigh in
if there is something to discuss and as a way to document what is being worked on and the reasoning behind changes.

Once a project is complete, I will close the issue.

@Hneuschmidt Hneuschmidt self-assigned this Feb 9, 2024
Hneuschmidt pushed a commit that referenced this issue Feb 9, 2024
Compiled products, models and pdf documentation have been removed.
Related Issue: #11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant