Write documentation in Wiki and README

ELVIS-Project / cbsmr-patternfinder

Content-based symbolic music retrieval service infrastructure.

MIT License

2 stars 0 forks source link

Write documentation in Wiki and README #2

Open vigliensoni opened 5 years ago

vigliensoni commented 5 years ago

Write Wiki with one page per container, as well as a page for the general overview of the app. Write thorough information about the API endpoints in order to facilitate communication with the app.

Also, add a page for end users, with screenshots and direct URLs to easily see the results of a given set of queries.

vigliensoni commented 4 years ago

The user should really understand how the searching is implemented, otherwise some results do not make any sense.