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:setup, doc #430

Closed
simonjwright opened this issue Oct 18, 2020 · 4 comments
Closed

README:setup, doc #430

simonjwright opened this issue Oct 18, 2020 · 4 comments
Assignees

Comments

@simonjwright
Copy link

README.md doesn’t mention the need to call setup.py, or how to call it (the documentation suggests using setup.py/easy_install/pip/..., whatever ... is, but we’ve already installed REQUIREMENTS.dev).

Also, it says the documentation is found in langkit/doc, but it’s actually in doc.

People might get started quicker if eval $(./manage.py setenv) was mentioned?

@pmderodat
Copy link
Member

Hello Simon,

Thank you for pointing that out. We have been reorganizing the Langkit project for several months, now. It’s not over yet, but we’ll try to update the readme to be useful ASAP in any case. :-)

Just being curious: did you notice this by chance, or are you trying to package Langkit in some distribution?

@pmderodat pmderodat self-assigned this Oct 20, 2020
@simonjwright
Copy link
Author

Just being curious: did you notice this by chance, or are you trying to package Langkit in some distribution?

I’ve been trying to get GNATstudio running with (a) Python3, (b) macOS Catalina. I’d picked up that libadalang depends on langkit, but what I hadn’t realised was that libadalang would manage this dependency itself, so I started off building langkit, hence the problems.

Another thing I noticed: running langkit’s setup.py install installed the langkit python module in such a way that libadalang’s REQUIREMENTS.dev failed (couldn’t overwrite langkit, so rest of requirements were omitted).

Just tried building & installing libadalang in an older machine without any previous installs of libadalang or langkit; worked just fine.

@pmderodat
Copy link
Member

Understood, thanks for the info. :-) We’ll keep you updated regarding the doc/README update.

@pmderodat
Copy link
Member

This issue has fallen through the cracks, sorry! The build/install procedure described in Langkit’s README should be up to date nowadays, so closing this. Of course, please let us know if you still have issues. Thanks!

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