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

clean up README.md #71

Merged
merged 1 commit into from
Sep 17, 2020
Merged

clean up README.md #71

merged 1 commit into from
Sep 17, 2020

Conversation

johnnychen94
Copy link
Collaborator

@johnnychen94 johnnychen94 commented Sep 14, 2020

This change is a little bit controversial:

  • (+-) update the introduction demo example
  • (+-) type design is moved to docs
  • (-) performance benchmark is way too outdated and is removed document the performance #70
  • (-) operation list is removed -- https://evizero.github.io/Augmentor.jl/assets/tiny_FlipX.png will no longer be valid if I clean the gh-pages branch wrt the Documenter's convention, where stable is placed at /Augmentor.jl/stable instead of /Augmenter.jl/.

@Evizero
Copy link
Owner

Evizero commented Sep 15, 2020

I see your point, of course.

That said, I have always been a fan of detailed readme.
Good bye performance section, I will miss you!

@johnnychen94
Copy link
Collaborator Author

johnnychen94 commented Sep 15, 2020

It's a hard decision. I'm actually not using this recently to spend enough time on updating it.

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

Successfully merging this pull request may close these issues.

None yet

2 participants