search

OTTAA-Project / Realiser

Repository for OTTAA's realiser algorithm, previously known as NLG, used for the OTTAA Labs option on the app.
GNU General Public License v3.0
0 stars 0 forks source link

Complete README #12

Closed lopezjuanma96 closed 2 years ago

lopezjuanma96 commented 2 years ago

Context

For releasing the repository publicly and allow other people to contribute to it's development and use the API as a service, we need a good documentation, including improving the README with usecases, rules, etc. For a proper doc follow

Causes/Justification

Giving potential users a brief description of what our Realiser is and how they can make use of it. Describing the project to potential devs that want to contribute to it. Provinding for both users and devs with a simple and direct way of proposing features and raising awareness about bugs.

Solution Alternatives

Repercussions

lopezjuanma96 commented 2 years ago

acknowledgements won't be added for now