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

docs: update README with latest changes #50

Merged
merged 1 commit into from
Oct 1, 2021

Conversation

Molkree
Copy link
Member

@Molkree Molkree commented Aug 23, 2021

Fixes:

@valentina-s, do you think just the link to the GitHub Actions introduction is enough or I should explain more here?

I have put short descriptions of each script/workflow in the main README and not in subfolder for each one because I have encountered some issues with imports (of spectrogram functions) when I moved them into separate folders (ooi/orcasound). I think it is due to the fact that they are not proper Python packages right now. Let's leave it like this for now because after converting them into proper Actions this won't be a problem (as they will be in separate repositories, each with their own util functions).

@Molkree Molkree added the documentation Improvements or additions to documentation label Aug 23, 2021
@Molkree Molkree requested a review from valentina-s August 23, 2021 01:05
@valentina-s
Copy link
Collaborator

@Molkree

Fixes:

@valentina-s, do you think just the link to the GitHub Actions introduction is enough or I should explain more here?

You can add a couple of more sentences about the context: we are accessing different datastreams, we can schedule and run jobs for free, etc.

I have put short descriptions of each script/workflow in the main README and not in subfolder for each one because I have encountered some issues with imports (of spectrogram functions) when I moved them into separate folders (ooi/orcasound). I think it is due to the fact that they are not proper Python packages right now. Let's leave it like this for now because after converting them into proper Actions this won't be a problem (as they will be in separate repositories, each with their own util functions).

Maybe __init__.py files would have helped? It is ok this way, since it is not too many functions.

@Molkree Molkree marked this pull request as draft September 5, 2021 13:30
@valentina-s valentina-s marked this pull request as ready for review October 1, 2021 00:58
@valentina-s valentina-s merged commit b2f4800 into orcasound:main Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants