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.

Sign up for GitHub

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

Jump to bottom

Readme.md - Add section "Usage" or similar #4623

Closed
toby63 opened this issue Dec 9, 2020 · 3 comments
Closed

Readme.md - Add section "Usage" or similar #4623

toby63 opened this issue Dec 9, 2020 · 3 comments
Labels
documentation github

Comments

@toby63
Copy link
Contributor

toby63 commented Dec 9, 2020

Context
Followup to #4622.

I think you could put the instructions for each Operating System into a new Main Section, maybe called Usage or something similar.
This way it has a better structure.
@Krzmbrzl
Copy link
Member

I agree. Ultimately though I would like to move these instructions into separate files that can then be linked to from the README (as is done for the build instructions) ☝️

@toby63
Copy link
Contributor Author

toby63 commented Dec 12, 2020 •
edited
Loading

I will probably add a pull request for this. I inform you, so there is no double work.

Update: I noticed that the information is a bit outdated and sparse. I guess I will rewrite it a little bit, to include steps for installation and maybe also a few more links to the website and wiki.

toby63 added a commit to toby63/mumble that referenced this issue Dec 12, 2020
@toby63
DOCS: Added folder "user-guides" to the documentation.
5fec10d 
Added user-guides for Windows, Linux and macOS.

Closes mumble-voip#4623.

Signed-off-by: Tobias Gerold <tobias@g3ro.eu>
@toby63 toby63 mentioned this issue Dec 12, 2020
Closed
@Krzmbrzl
Copy link
Member

Krzmbrzl commented Sep 9, 2022

Usage guides shouldn't be written here on GitHub. They should be created on our Website (or until the docs have moved there: in our wiki) and then we can link to that from the README file.

@Krzmbrzl Krzmbrzl closed this as completed Sep 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation github
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

WIP: DOCS: Add Userguides to the documentation. toby63/mumble
2 participants
@Krzmbrzl @toby63