ddionrails / collect_stata

Accumulate data from stata files and write it into an open format

BSD 3-Clause "New" or "Revised" License

0 stars 1 forks source link

Update the Readme #32

Closed hansendx closed 5 years ago

hansendx commented 5 years ago

The Readme only contains basic information for installation please document:

Production installation
Use information
Purpose of the project

18

afuetterer commented 5 years ago

I ran into this: https://github.com/ddionrails/ddi.py/tree/master/docs

Is this reusable in some way?

afuetterer commented 5 years ago

Another thing: You wrote "pipenv install -e ." under "Setup for development". This actually altered the Pipfile and Pipfile.lock. Is this intended? Right now running "pipenv install --dev" already installs collect_stata.

hansendx commented 5 years ago

Another thing: You wrote "pipenv install -e ." under "Setup for development". This actually altered the Pipfile and Pipfile.lock. Is this intended? Right now running "pipenv install --dev" already installs collect_stata.

Yes, the pipenv install -e . part could be removed with the README.md update.

afuetterer commented 5 years ago

I see.

mpahl commented 5 years ago

I ran into this: https://github.com/ddionrails/ddi.py/tree/master/docs

Is this reusable in some way?

This is an old Sphinx documentation. Should I revive it for collect_stata?

hansendx commented 5 years ago

No, we can create a new sphinx documentation with napoleon and the new docstrings.