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) Start a beginners guide #111

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Danielduel
Copy link

Change requests are very welcome, hopefully my English wasn't very bad :D

@inclement
Copy link
Owner

Thanks @Duelsik, I really appreciate contributions like this.

In this case I'm wondering if a better place to put this kind of guide might be a project wiki, with a shorter summary in the README specifically mentioning that new users will want to check the default terminal and similar settings. The advantage of this would be that a wiki is more easily changed and has less of a bar to meet to be useful. In contrast I'm not sure if/how would be best to handle it in the git repo as I haven't committed to any doc system.

How would you feel about it if I turned on the github wiki to hold this information, and then we could turn this PR into a README update mentioning the core details and linking the wiki page?

@Danielduel
Copy link
Author

@inclement

No problem with that, not sure how github wiki works, but since it is "wiki" - I expect it will be fine for this usecase.
Alternatively you can create separate repository and hold something like GitBook project there.

I put some effort into this short file, but I kept in mind that the main reason that I've started this is to show the maintainer "Hey everything is supernice, but... since I was using Windows/Mac/Ubuntu whole life - could you explain how to use this vivarium thing?" - so don't worry, it is just a conversation starter.

So! Not sure how this github wiki feature works, let's try it out ;)
Feel free to close this PR once you you read this comment, I suggest continuing the topic in #110

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