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

Add more information in README.md #210

Merged
merged 17 commits into from Nov 4, 2018
Merged

Add more information in README.md #210

merged 17 commits into from Nov 4, 2018

Conversation

tkf
Copy link
Member

@tkf tkf commented Oct 25, 2018

Preview: https://github.com/tkf/pyjulia/blob/readme/README.md

TODO:

@tkf tkf added this to the 0.2 milestone Oct 25, 2018
@tkf tkf force-pushed the readme branch 3 times, most recently from f6fd84a to d17b90f Compare October 25, 2018 02:53
@tkf tkf force-pushed the readme branch 2 times, most recently from a5acafc to 2c56f62 Compare October 26, 2018 01:57
"`pyjulia`" and "pyjulia" are replaced with "PyJulia" (unless it
appears as a part of URL).  I'm OK with "pyjulia".  Using "PyJulia"
only because it appears as the title of README.md.
@tkf
Copy link
Member Author

tkf commented Oct 26, 2018

@stevengj Can you have a look at updated README? Especially the notes on the pre-compilation cache? https://github.com/tkf/pyjulia/blob/readme/README.md#pre-compilation-mechanism-in-julia-10

@tkf
Copy link
Member Author

tkf commented Oct 26, 2018

Here is how it'd be rendered in PyPI https://test.pypi.org/project/julia/0.2.0.dev1/

```
pip install julia
```console
$ python3 -m pip install --user julia
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I switched pip to python3 -m pip everywhere since it's a common pitfall that pip uses different Python executable than python.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... and added --user since that's likely what they want.

@stevengj
Copy link
Member

Fine, although what we did previously was not technically monkey patching. I’m not sure it is a good idea to try to explain what is going wrong in the readme. Just say that pecompilation doesn’t work with 1.0 and link the issue.

@tkf
Copy link
Member Author

tkf commented Oct 31, 2018

We are changing the path of the Julia executable which is conceptually like mutating a function. But it is done through the public API (but in an implementation-dependent manner) so I guess I'm stretching it somewhat to call it a monkey patch.

The pre-compilation issue was asked by multiple users (including me) so I think it would be nice to explain it in some details. How about blending it into fake-julia/README?

@tkf
Copy link
Member Author

tkf commented Oct 31, 2018

Here is the new fake-julia documentation I suggest: https://github.com/tkf/pyjulia/tree/readme/julia/fake-julia

@tkf tkf merged commit d775089 into JuliaPy:master Nov 4, 2018
@tkf
Copy link
Member Author

tkf commented Nov 4, 2018

@stevengj Thanks a lot for reviewing!

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

Successfully merging this pull request may close these issues.

None yet

2 participants