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

Update Github readme #157

Open
sunix opened this issue Apr 28, 2014 · 1 comment
Open

Update Github readme #157

sunix opened this issue Apr 28, 2014 · 1 comment
Labels
Documentation
Milestone
current iteration

Comments

@sunix
Copy link
Contributor

sunix commented Apr 28, 2014

The README should explain

  • What does the project do, the main features
  • have few screenshots of the plugin
  • how to build the project
  • how to dev with the project (Eclipse + Intellij)
  • the global architecture
@sunix sunix added this to the current iteration milestone Apr 28, 2014
mleduque added a commit that referenced this issue May 15, 2014
@mleduque
Change description of the build process (reference SDK project) - #157
7b42fac
@mleduque mleduque assigned sunix and mleduque and unassigned sunix and mleduque May 15, 2014
mleduque added a commit that referenced this issue May 15, 2014
@mleduque
Add screenshots to the readme file - #157
937cafb
@mleduque
Copy link
Contributor

I don't think the architecture should be in the readme.
It can be linked from the readme, but it should probably be in another .md file. Actually, the same could be said for "how to dev".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
current iteration
Development

No branches or pull requests
2 participants
@mleduque @sunix