-
Notifications
You must be signed in to change notification settings - Fork 264
Update README.md #669
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
Update README.md #669
Conversation
Added a note to troubleshoot a possible issue when using Windows.
This would also need to be included in every API repo. |
@@ -11,6 +11,8 @@ To build and deploy your changes for previewing in a [`jquery-wp-content`](https | |||
|
|||
The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://sourceforge.net/projects/gnuwin32/files/">GnuWin32</a>. | |||
|
|||
**Note**: If you're using Windows and you receive the error "Error" when executing the task "build-xml-entries:all", try to add the DLL "libwinpthread-1.dll" in the root of the project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please wrap the filenames and the grunt task in backticks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Replaced double quotes with backticks
I can do that @scottgonzalez. |
Is this PR good to be merged @arthurvr? |
I would like somebody to actually confirm that file is needed/appropriate. I'm not using windows myself :) |
@@ -11,6 +11,8 @@ To build and deploy your changes for previewing in a [`jquery-wp-content`](https | |||
|
|||
The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://sourceforge.net/projects/gnuwin32/files/">GnuWin32</a>. | |||
|
|||
**Note**: If you're using Windows and you receive the error "Error" when executing the task `build-xml-entries:all`, try to add the DLL `libwinpthread-1.dll` in the root of the project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you receive the error "Error" when executing the task
Is "error" the only thing it throws?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, unfortunately.
ping, somebody?
|
If @AurelioDeRosa got everything working on Windows he's accomplished more than I ever could. Which version of Windows is this? |
I'm running on Windows 8.1 |
I'm running Windows 8.1 as well and i can |
@dmethvin I'm using http://git-scm.com/download/win |
Okay, must be something specific to that setup. I just looked and can't find that DLL anywhere on my drive, but that part of the build at least works fine. |
BTW, is that the recommended setup for Windows now? My quick search on contribute.jquery.org and jquery-wp-content didn't find anything. I've used cygwin and msysgit with success but never just Windows git by itself. |
I'm not sure what you mean by "recommended setup". Do you mean "Is this the coolest tool used on Windows today?" or "Is this the tool we, as the jQuery Foundation, suggest to people?"? |
The latter. The README for core has links to git (the one you linked) and node for Windows, but I've always installed msysgit because, well, because it works. |
Yes, indeed the guidelines suggest the tool I'm using, but to be honest, I already had it installed and it's the one I've always used. At the end of the day, I'd vote for adding the note. I doesn't have any drawbacks by its own and may help developers in solving a hard-to-spot issue. Also, it's very small. What do you think @dmethvin? |
It doesn't seem like this is a problem specific to api.jquery.com. Is there a reason why the api.jqueryui.com repo recommends a different source for the xml utils? Maybe the ones from there wouldn't throw the error. |
See #676. |
Yup, I will change those URLs in every repo after this one is merged. |
This seems good to me, just bumping it. |
Added a note to troubleshoot a possible issue when using Windows.