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

script to download and build deps. updated README. add gitignore. remove build products from repo. #7

Closed
wants to merge 3 commits into from

Conversation

EsGeh
Copy link

@EsGeh EsGeh commented Jun 29, 2019

This hopefully makes this repository a lot easier to use.
I expect the maintenance overhead to decrease too.

dependencies are being managed by the experimental fish script https://github.com/EsGeh/git_deps.
All dependencies are exactly specified in the file ./dependencies.fish.

It's just a suggestion. Let's discuss :-)

…ove build products from repo.

This hopefully makes this repository a lot easier to use.
I expect the maintenance overhead to decrease too.
@TheKikGen
Copy link
Owner

Why not writing a how to with the existing components first ?

@EsGeh
Copy link
Author

EsGeh commented Jul 2, 2019

Hmm. My script and modifications are pretty much based on github issue 6 and the wiki of this repository.
After having figured out how to compile and use USBMidiKliK I just thought I could share this solution in the form of a reproducable script to simplify things.
In my opinion a script can be considered executable documentation.
But it's a question of taste, I guess.
Basically, it solves the following problems:

  • document dependencies including the exact versions (via git hash)
  • automatize and document the process of downloading and building the dependencies
  • avoid confusion about how to create the correct directory hierarchy
  • simplify integration into other projects and scripts

I added the necessary documentation to the README file.

All one has to do is to enter

$ ./scripts/init.fish
$ make

I am already using https://github.com/EsGeh/git_deps in some other projects and it works pretty well, so far.
There are still things that can be improved (e.g. providing better output and logging).
Integrating these improvements will be as simple as changing a git hash in ./scripts/init.fish.

@steeley steeley mentioned this pull request Mar 23, 2022
@TheKikGen TheKikGen closed this Dec 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants