Interpreter–part 5 of n–Documentation

Series:

  1. http://msprogrammer.serviciipeweb.ro/2018/07/16/interpreterpart-1-of-n/ – Idea
  2. http://msprogrammer.serviciipeweb.ro/2018/07/23/interpreterpart-2-of-n/ – Coding
  3. http://msprogrammer.serviciipeweb.ro/2018/07/30/interpreterpart-3-of-n/ – Testing
  4. http://msprogrammer.serviciipeweb.ro/2018/08/06/interpreterpart-4-of-n/  – Deploy
  5. http://msprogrammer.serviciipeweb.ro/2018/08/13/interpreterpart-5-of-n/ – Documentation
  6. http://msprogrammer.serviciipeweb.ro/2018/08/20/interpreterpart-6-of-n/ – Ecosystem / usage

After all this steps, now it is the moment to have Documentation. Basically, if nothing have changed, is the same as the idea –  http://msprogrammer.serviciipeweb.ro/2018/07/16/interpreterpart-1-of-n/  .

However , there are some points to add:

  1. Clear use of the software ( examples, tutorials, videos, others)
  2. Added badge/link to the software  (nuget,  see https://github.com/ignatandrei/Interpreter  )
  3. Added badge to  build ( see https://github.com/ignatandrei/Interpreter  )
  4. Added badge to license ( see https://github.com/ignatandrei/Interpreter  )
  5. Add reference to any third party software that you are using( any other nuget components / dot net tools – https://github.com/ignatandrei/Interpreter/blob/master/application/Interpreter/thirdParty.md )

But the most important part is to show how you use it in a real project…