search

inclement / vivarium

A dynamic tiling Wayland compositor using wlroots
GNU General Public License v3.0
367 stars 13 forks source link

(docs) Start a beginners guide #111

Open Danielduel opened 2 years ago

Danielduel commented 2 years ago

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

inclement commented 2 years ago

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 commented 2 years ago

@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 https://github.com/inclement/vivarium/issues/110