search

eregs / regulations-core

An engine that supplies the API that allows users to read regulations and their various layers.
Creative Commons Zero v1.0 Universal
16 stars 27 forks source link

Update mention of example_settings.py in README.md #61

Closed gregoryfoster closed 7 years ago

gregoryfoster commented 7 years ago

Hi, I'm new to regulations-core and a relative Python newb, so my apologies in advance should I miss the obvious. Helpful pointers welcome!

In walking through the documentation on building regulations-core from source, there's mention of an example_settings.py file which I'm unable to find in the source repository. Should this be a reference to regcore/settings/base.py?

Thank you!

cmc333333 commented 7 years ago

Good call, @gregoryfoster, it should be regcore/settings/base.py (as configured here). Would you mind making a PR?

The relationship between -parser, -core, and -site can be pretty confusing. You might want to poke at a specific use case, like ATF's repo. In particular, their Docker setup should get you going pretty fast.

cmc333333 commented 7 years ago

Also, thanks for taking a look! Feel free to reach out through issues; we can work through any issues you run into.

cmc333333 commented 7 years ago

Resolved by #62