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

Adds a quick-start guide #17

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

maxiestudies
Copy link

I documented the steps that I had to do to get the software running under Ubuntu 20. I think this might be useful for others, hence the pull request

@choppsv1
Copy link
Collaborator

Hi

Thanks for this effort. Are you approaching this as a quick start guide for getting started on development of munet? I'm asking b/c I would expect a non-development user to pip install munet.

@maxiestudies
Copy link
Author

I do feel kind of stupid as I didn't thought of installing the package with pip. I guess potential developers will know or can figure out the stuff that I wrote down, so maybe it's not very useful as a dev startup guide.
I can either modify this or write a new file for regular users? I like writing documentation in general and would be glad to help documenting this project. I would like to hear you opinion on what do you think should be documented first

@choppsv1
Copy link
Collaborator

choppsv1 commented Oct 23, 2022

The work is appreciated! I will adopt some of your text to a section I'll add in the README for how to develop munet using ubuntu and poetry. I'll also add a bit about using pip to install for non-development use. Thanks again!

We definitely need some documentation for users. It's severely lacking. If you have some example scenarios you've setup and used (e.g., like the ones under examples, but your use case). That would be useful. And documenting what you did to get to that point will surely help people.

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.

3 participants