Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Update README with clearer instructions #46

Closed
wants to merge 2 commits into from

3 participants

@nigelbabu

mgoodwin faced trouble with setting up input with the instructions in README. I've updated most of the current gotcha's now. Another update to README needs to land with tellusmore.

@tofumatt tofumatt commented on the diff
README.md
((6 lines not shown))
to install the required Python libraries.
+Input uses a vendor library to manage its non-compiled dependencies. At the root of your

This isn't a git submodule already? Shouldn't you be able to do a recursive checkout on the main repo to get these?

Oh, it's not. But shouldn't it be?

Happy to do that.

Might want to warn IT about it/change any update script that calls it in. But yes: that's a much better idea ^_^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@tofumatt tofumatt commented on the diff
README.md
@@ -83,6 +88,8 @@ The Internet has plenty of of documentation on setting up a Django application
with any web server. If you need a wsgi entry point, you can find one in
``wsgi/reporter.wsgi``.
+Remember to set a SECRET_KEY in `settings/local.py`.

Is this required for local installs? Or if so: should it be? Seems like busy work for local development.

I don't think it's required. But probably good to have since django keeps complaining!

Oh, right. I think that's actually funfactory, but it's just console noise. People can see where to turn it off in the error message. This makes it sound required, and I like fewer required steps in READMEs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@tofumatt

Notes seem to skirt around the issues rather than fixing them -- wouldn't it be better to fix these issues rather than documenting them?

@mythmon
Owner

Closing this, since it is 6 months old.

@mythmon mythmon closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 15, 2012
  1. Update README with clearer instructions

    Nigel Babu authored
  2. Added vendor as submodule

    Nigel Babu authored
Something went wrong with that request. Please try again.