Closed
Bug 635166
Opened 14 years ago
Closed 14 years ago
SDK readme should mention explicitly that you need to be in the SDK's root directory to run "bin\activate".
Categories
(Add-on SDK Graveyard :: Documentation, defect)
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: KWierso, Assigned: wbamberg)
Details
Attachments
(1 file)
729 bytes,
patch
|
myk
:
review+
|
Details | Diff | Splinter Review |
README.txt currently says "in the same directory that this file is in".
It'd be nice to have it a little clearer, explicitly mentioning the root folder in the SDK.
I know when I first started using the SDK, I hit this, I tried running "activate" from within the "bin" folder, which doesn't work.
[01:56] <Aurrin> Hm.
The batch file tries to call a python module in python-lib, but doesn't tell it how to find that.
[02:01] Ohhhhh
[02:02] You go to the *root* folder of the sdk to run the scripts, not the /bin folder.
<KWierso> oh yeah
<Aurrin> Yeah, that would have been helpful in the README.
[02:03] <KWierso> it kinda is
Maybe change that sentence to:
"To get started, first enter the same directory that this file is
in (the SDK's root) using a shell program."
Reporter | ||
Comment 1•14 years ago
|
||
Alternatively, maybe make the error when run from within "/bin/" mention possible reasons why the error is showing?
Currently, you get this:
admin@KWIERSODESKTOP /h/JETPACK/addon-sdk/bin
$ activate
Traceback (most recent call last):
File "<string>", line 1, in <module>
ImportError: No module named jetpack_sdk_env
(Or at least, that's what the module's called in this somewhat old version of the SDK that I have set up...)
An alternative to the alternative, make README.txt say something like "(this will only work from the root directory!)"?
Reporter | ||
Comment 2•14 years ago
|
||
I should add that the SDK's docs explicitly mention "root directory", but you can't get to those until after you successfully run bin/activate (or look online for a copy).
Assignee | ||
Updated•14 years ago
|
Assignee: nobody → wbamberg
Assignee | ||
Comment 3•14 years ago
|
||
git complains about whitespace, but I assume this is because of the CRLF line endings?
Attachment #518547 -
Flags: review?(myk)
Updated•14 years ago
|
Attachment #518547 -
Flags: review?(myk) → review+
Assignee | ||
Comment 4•14 years ago
|
||
Status: NEW → RESOLVED
Closed: 14 years ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•