{"action":"created","issue":{"url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/7","repository_url":"https://api.github.com/repos/ViewTouch/viewtouch","labels_url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/7/labels{/name}","comments_url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/7/comments","events_url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/7/events","html_url":"https://github.com/ViewTouch/viewtouch/issues/7","id":75854953,"number":7,"title":"Project needs more documentation - How to get it running on server and clients","user":{"login":"thomasfrivold","id":1677630,"avatar_url":"https://avatars.githubusercontent.com/u/1677630?v=3","gravatar_id":"","url":"https://api.github.com/users/thomasfrivold","html_url":"https://github.com/thomasfrivold","followers_url":"https://api.github.com/users/thomasfrivold/followers","following_url":"https://api.github.com/users/thomasfrivold/following{/other_user}","gists_url":"https://api.github.com/users/thomasfrivold/gists{/gist_id}","starred_url":"https://api.github.com/users/thomasfrivold/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thomasfrivold/subscriptions","organizations_url":"https://api.github.com/users/thomasfrivold/orgs","repos_url":"https://api.github.com/users/thomasfrivold/repos","events_url":"https://api.github.com/users/thomasfrivold/events{/privacy}","received_events_url":"https://api.github.com/users/thomasfrivold/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2015-05-13T05:34:58Z","updated_at":"2016-02-10T11:09:01Z","closed_at":null,"body":"Project needs more documentation - How to get it running on server and clients\r\n\r\nHow does one compile the program\r\nHow does one start the server engine. \r\nWhat does the server engine do? \r\nWhat ports does it operate? \r\nWhat are the dependencies?\r\nThe graphics files - Where are they? \r\n"},"comment":{"url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/comments/182318744","html_url":"https://github.com/ViewTouch/viewtouch/issues/7#issuecomment-182318744","issue_url":"https://api.github.com/repos/ViewTouch/viewtouch/issues/7","id":182318744,"user":{"login":"thomasfrivold","id":1677630,"avatar_url":"https://avatars.githubusercontent.com/u/1677630?v=3","gravatar_id":"","url":"https://api.github.com/users/thomasfrivold","html_url":"https://github.com/thomasfrivold","followers_url":"https://api.github.com/users/thomasfrivold/followers","following_url":"https://api.github.com/users/thomasfrivold/following{/other_user}","gists_url":"https://api.github.com/users/thomasfrivold/gists{/gist_id}","starred_url":"https://api.github.com/users/thomasfrivold/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thomasfrivold/subscriptions","organizations_url":"https://api.github.com/users/thomasfrivold/orgs","repos_url":"https://api.github.com/users/thomasfrivold/repos","events_url":"https://api.github.com/users/thomasfrivold/events{/privacy}","received_events_url":"https://api.github.com/users/thomasfrivold/received_events","type":"User","site_admin":false},"created_at":"2016-02-10T11:09:01Z","updated_at":"2016-02-10T11:09:01Z","body":"This is pretty silly.\n\nA software package regardless of who has made it and what history it has\nneeds explicit documentation.\nThe documentation should\n(0) System requirements\n(1) Introduction. Who is this software intended for, what problems does it\nsolve?\n(1) How the software is working, what are the \"moving parts\".\n(2) Describe every function of the system available to the user.\nScreenshots necessary.\n(3) Describe every function of the system available to administrator.\nScreenshots necessary.\n(4) Describe how to do every task which a regular user will do. Screenshots\nnecessary.\n(5) Describe how to do every task which an administrator will do.\nScreenshots necessary.\n(6) License\n(7) Third party service providers (hosting providers, support providers,\ngear providers) can be added here.\n\nThe entire documentation needs to be written explicitly. This means that it\nshould be written without personal quips and without anecdotes and stories.\nThese are not relevant to a pure documentation, but can be added to the\nproject homepage and or included in a final chapter if absolutely\nnecessary. Only the explicit information intended for the transfer of\nknowledge is permissible in a quality documentation. The documentation\nshould be standing on its own two legs and no require interaction with\nanyone else in order to bring the software up and running, and using it on\na daily basis.\n\nBest regards,\nThomas\n\n\n\nOn 9 February 2016 at 13:57, milkboy007 <notifications@github.com> wrote:\n\n> lolz. i am currently evaluating the software. yes, \"POS is very serious\n> software\"\n> im just stating that the is no documentation for administration.\n> not to sound ungrateful or anything, unlike other open source POS, (like\n> openbravo pos + forks, and others), there is no literature to read on.\n> will there be any plan for written administration documentation? easier to\n> access for reference.\n>\n> calling would be a huge inconvenience for both of us, as i live in a\n> different continent/timezone.\n> is there any recorded video on you previous trainings? i cant write the\n> documentation from it if you have any.\n>\n> —\n> Reply to this email directly or view it on GitHub\n> <https://github.com/ViewTouch/viewtouch/issues/7#issuecomment-181853834>.\n>\n"}}