{"action":"opened","issue":{"url":"https://api.github.com/repos/danielbrodin/atom-project-manager/issues/319","repository_url":"https://api.github.com/repos/danielbrodin/atom-project-manager","labels_url":"https://api.github.com/repos/danielbrodin/atom-project-manager/issues/319/labels{/name}","comments_url":"https://api.github.com/repos/danielbrodin/atom-project-manager/issues/319/comments","events_url":"https://api.github.com/repos/danielbrodin/atom-project-manager/issues/319/events","html_url":"https://github.com/danielbrodin/atom-project-manager/issues/319","id":213313109,"number":319,"title":"Usage is confusing for a newcomer","user":{"login":"Kaba2","id":2399754,"avatar_url":"https://avatars3.githubusercontent.com/u/2399754?v=3","gravatar_id":"","url":"https://api.github.com/users/Kaba2","html_url":"https://github.com/Kaba2","followers_url":"https://api.github.com/users/Kaba2/followers","following_url":"https://api.github.com/users/Kaba2/following{/other_user}","gists_url":"https://api.github.com/users/Kaba2/gists{/gist_id}","starred_url":"https://api.github.com/users/Kaba2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kaba2/subscriptions","organizations_url":"https://api.github.com/users/Kaba2/orgs","repos_url":"https://api.github.com/users/Kaba2/repos","events_url":"https://api.github.com/users/Kaba2/events{/privacy}","received_events_url":"https://api.github.com/users/Kaba2/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-03-10T11:11:10Z","updated_at":"2017-03-10T11:11:10Z","closed_at":null,"body":"Hi there! I am a newcomer to Atom from Sublime Text. I understand Atom does not have native support for projects yet, and that this package tries to cover on that. Good work on helping us with this package on the meantime! Here are some suggestions on how to improve the frontpage documentation.\r\n\r\n### Problem\r\n\r\nThe documentation on the frontpage is confusing to me, and as a result I haven't been successful in getting the package to work this far. What I want is to have a local project file on my project directory, to be stored with version control, as I can do in Sublime Text. \r\n\r\n### Frontpage documentation\r\n\r\nThe frontpage reads:\r\n\r\n    All these settings can be added to a project.cson file in the root folder of the project. It follows the below example, but without the array.\r\n\r\n    [\r\n      {\r\n        title: 'Project Manager'\r\n        group: 'Atom'\r\n        paths: [\r\n          '/path/to/project-manager'\r\n        ]\r\n        devMode: true\r\n        settings:\r\n          'editor.tabLength': 4\r\n          'editor.showInvisibles': true\r\n      }\r\n    ]\r\n\r\nI gather that I need to create project file on the root directory of my project. The project file should resemble the above example. \r\n\r\n### Questions\r\n\r\nThe following questions are meant to describe my thinking process.\r\n\r\n* Must `project.cson` be named exactly like that, or can I name it like `foobar.cson`? \r\n* If the latter, how does the project manager know which `.cson` file to use? \r\n* In fact, the project manager does not seem to find any project after creating a `project.cson` file.  Am I missing something? Do the local project files work at all?\r\n* What does \"the array\" refer to?\r\n* If \"the array\" refers to the outermost array in the cson file, and it should not be there, then why is it part of the example?\r\n* Using the package-manager itself as an example project confuses me on whether some of these settings need to be there to get the project to work. In particular, `'/path/to/project-manager'` suggests that I should replace it with the physical path to the package manager on my hard disk.\r\n* I guess that `paths` should list the set of of paths for the project to include.\r\n* Can I use a path relative to the project file (e.g. `.`), or do the paths need to be absolute paths, as in the example? Requiring an absolute path would be bad, because then I cannot move the project on my hard disk.\r\n* Why do I need to specify a path at all? Could the project root directory not be taken by default to be the same as the directory where the project file resides?\r\n\r\nIn summary, I would like to see a clear \"Hello, world!\" example for the package manager, using a local project file. It would be great if the frontpage documentation was improved so that the above questions were answered, and the ambiguities removed!\r\n"}}
{"actor":{"display_login":"Kaba2"}}