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.

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

Code review summary.md #11

Open
ljxiaoBU opened this issue Nov 12, 2017 · 0 comments
Open

Code review summary.md #11

ljxiaoBU opened this issue Nov 12, 2017 · 0 comments

Comments

@ljxiaoBU
Copy link
Collaborator

My computer system is Windows so I cannot run your application properly. So my suggestions are purely based on reading the files in your github repository.

  • The instructions on your README file could be more detailed from how to install the application to how to use the functions properly.
  • There could be more explanation on how each algorithm works together as a whole. Since your code were mainly written in swift, I personally find it difficult to understand each algorithm even though many of your swift functions are well-commented.
  • Your directory structure and file organization could be more concise, like if there suppose to be a new version of your application under Versions/current directory. Also it would be nice if you include some reference sites in your description file.
  • Your project looks fancy and interesting and I am looking forward for an user-friendly app.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant