docs could be a bit easier to follow for newer developer

gregmuellegger / django-autofixture

Can create auto-generated test data.

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

462 stars 118 forks source link

docs could be a bit easier to follow for newer developer #84

Open DanHitt opened 8 years ago

DanHitt commented 8 years ago

Thanks for creating this, it saved me tons of time as you pointed out but (being new) it did take me a while to figure out how to use it. I was so happy to find something to autopopulate for me, I can't tell you how much i wanted to hug you.

I've forked and cleaned up the readme just a bit and added a bit to the examples to make them a little more clear to new devs. I'd like to submit a pull!

Thanks again!

gregmuellegger commented 8 years ago

Thanks for the good feedback! :) It's indeed a little more complex to use than it needs to be, I haven't changed the API since 6 years though.

A pull request for making docs better and easier to understand would be super awesome! Thanks for offering the help. It's always tricky to know how to make something approachable for newcomers if you already know the project quite well :)