update readme and move cli related scripts to cli directory #75
Conversation
Codecov Report
@@ Coverage Diff @@
## master #75 +/- ##
=====================================
Coverage 45% 45%
=====================================
Files 9 9
Lines 1842 1842
=====================================
Hits 829 829
Misses 1013 1013Continue to review full report at Codecov.
|
README.md
Outdated
| :exclamation: The project is in early prototype stage. :exclamation: | ||
|
|
||
| ### How does it work | ||
| It use doc2vec for word embedding. Similarity based on [WMD Distance](http://proceedings.mlr.press/v37/kusnerb15.pdf) is calculated. |
There was a problem hiding this comment.
It uses doc2vec for word embedding and [WMD](http://proceedings.mlr.press/v37/kusnerb15.pdf) as a distance metric.
README.md
Outdated
| It use doc2vec for word embedding. Similarity based on [WMD Distance](http://proceedings.mlr.press/v37/kusnerb15.pdf) is calculated. | ||
|
|
||
| ### How to run | ||
| For now only command line interface is supported. Have a look at [cli](https://github.com/marco-c/crashsimilarity/tree/master/crashsimilarity/cli) directory. |
README.md
Outdated
|
|
||
| :exclamation: The project is in early prototype stage. :exclamation: | ||
|
|
||
| ### How does it work |
There was a problem hiding this comment.
Since the paragraph is really short for now, let's remove the title and have a single Description section
README.md
Outdated
| @@ -3,12 +3,22 @@ | |||
| [](https://travis-ci.org/marco-c/crashsimilarity) | |||
| [](https://codecov.io/gh/marco-c/crashsimilarity) | |||
|
|
|||
| ## Tests | |||
| ### Description | |||
| Crashsimilarity is a tool to cluster slightly different crash reports, reporting the same problem. It is built for mozilla and support crash reports produced by [breakpad](https://chromium.googlesource.com/breakpad/breakpad/). | |||
There was a problem hiding this comment.
It is built for mozilla and support crash reports produced by [breakpad](https://chromium.googlesource.com/breakpad/breakpad/). -> It supports crashes reported to the Mozilla [Socorro crash reporting system](link to socorro home page)
No need to mention Breakpad, as the project doesn't really depend on the particular software that generates the reports.
There was a problem hiding this comment.
Hm, indeed. My point was to tell that for now we are can only work with one particular provider.
I will remove this mention.
There was a problem hiding this comment.
(link to socorro home page)
Should it be link to https://crash-stats.mozilla.com/ or to https://github.com/mozilla/socorro ?
There was a problem hiding this comment.
Let's use the first one, as it's more user-facing
|
Update readme.md and resolve merge confilct. |
What do you think? Is it enough description for the current state?
Issue: #2