Update README
Tjzabel opened this issue · comments
Summary
- This issue is a…
- Bug report
- Feature request
- Other issue
- Question
- Describe the issue / feature in 1-2 sentences:
The current state of the README only tailors towards developers who wish to get involved and build their own ISO. We need to cater towards our current audience and start the README with instructions on how to download the ISO, and install TigerOS on their own machine.
Background
There have been a few comments from others who have wanted to download TigerOS on their own machine, but when checking out the repo, discovered the README only includes developer instructions.
Feature request
What does it do?:
Provides clear instructions on how to install TigerOS.
Does this feature affect other parts of TigerOS?:
Nope
I think we should just remove the instructions from the readme and put them in the wiki clearly
Also I think the README should reference the wiki so people know to check there for info. I don't think it's explicitly in the README at all, most people know to check the README but I feel less think to check the GitHub wiki.
In addition to all of these comments, I believe it would be helpful to show a general idea of what TigerOS is. To do this, I would like to have a summary of what makes TigerOS worthy of a remix, and also show off some of the screenshots we have.
The README should be an introduction for potential users, not for prospective developers. However, we should have a developers section of the README at the end to point contributors in the right direction on how to properly help.
Let me know if you agree with any of the above.
I am blocking this issue on the new website being completed, so we know where we stand on documentation and what we need to add into the README.
As a side note, it would be a good idea to merge the UI Tweaks README into the overall TigerOS README. That way, users can get a much better idea right off the bat what TigerOS looks like.
This is essentially done (on GitLab's side).