anujkhare / iregnet

7 stars 12 forks source link

Add some "developer documentation" to the README #61

Open anujkhare opened 5 years ago

anujkhare commented 5 years ago

I'm revisiting this code after a long time and being out of touch with R development, don't remember basic things like:

  1. How do you set up a development environment?
  2. How do I run the tests?
  3. How to compile the API documentation?

These are simple commands, might be easy enough to compile them. Maybe, we can add a makefile for this?

theadityasam commented 5 years ago

Should I include these in the Vignette? Or should we go for a separate document?