Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README gives incorrect instructions #124

Open
mivade opened this issue Jan 25, 2015 · 1 comment
Open

README gives incorrect instructions #124

mivade opened this issue Jan 25, 2015 · 1 comment

Comments

@mivade
Copy link

mivade commented Jan 25, 2015

I have been unable to get localshop to work at all based on following the README directions. Here is a list of problems with the documentation:

  • The instructions for starting it appear to require two commands to be run, but don't include an & to run them in the background, nor is there an explanation of what is going on with the second command (For example, what do the -B and -E options even do? Why do I need them?).
  • The instructions for how to choose another port are not relevant to the preceding lines about how to start the server, and evidently what is given refers to a deprecated way of running localshop.
  • The honcho method mentions a "Procfile" which may or may not exist. I couldn't figure out what that referred to, and so that method did not work.
  • The command for uploading fails. It should instead be something like python setup.py sdist upload -r local. However, if I do this, I get a 200 OK response but nothing appears when I refresh the web interface, nor is there anything in ~/.localshop/files (which doesn't even exist).
@canassa
Copy link
Collaborator

canassa commented Feb 4, 2015

Thanks for the feedback. I completely agree that the README is not very clear and needs some love.

I will start working on it as soon as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants