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

docs: clarify the different way to build cln #5479

Merged

Conversation

vincenzopalazzo
Copy link
Collaborator

@vincenzopalazzo vincenzopalazzo commented Jul 29, 2022

This will clarify the different ways to build core lightning, and also we speed up the core lightning building process for the people that want just to install cln.

The procedure is already tested by my docker image on alpine is available here

Just thinking also to add how to disable rust if the user does not want to compile the plugin.

Signed-off-by: Vincenzo Palazzo vincenzopalazzodev@gmail.com

@vincenzopalazzo vincenzopalazzo marked this pull request as ready for review July 29, 2022 14:27
@vincenzopalazzo vincenzopalazzo force-pushed the macros/split_dev_doc branch 3 times, most recently from e345b83 to fb4399b Compare July 29, 2022 20:44
Copy link
Collaborator

@endothermicdev endothermicdev left a comment

Choose a reason for hiding this comment

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

Just a couple grammar fixes, but looks good otherwise. Do we want to return to the pip requirements file? I'm not sure it's necessary with only three packages, but maybe it would be nice to have in the future?

doc/INSTALL.md Show resolved Hide resolved
doc/INSTALL.md Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved
doc/INSTALL.md Show resolved Hide resolved
@vincenzopalazzo
Copy link
Collaborator Author

Thanks, I was seeking a grammar review :)

I'm not sure it's necessary with only three packages, but maybe it would be nice to have in the future?

I hope to remove the python deps for not dev after we converge with #5445 and also I would like to avoid putting this file because the people usually when see a requirements.txt tend to do "Ah yes, I do not need to read the install docs it is just pip3 install -r requirements.tx" and after they can not run the test.

Copy link
Collaborator

@endothermicdev endothermicdev left a comment

Choose a reason for hiding this comment

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

I tested and verified this install procedure, and it worked fine apart from needing the --enable-rust flag for the configuration tool.

doc/INSTALL.md Outdated Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved
@vincenzopalazzo
Copy link
Collaborator Author

Trivial rebase and make the change requested, thanks to catch my mistake.

Copy link
Collaborator

@endothermicdev endothermicdev left a comment

Choose a reason for hiding this comment

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

ACK 54095ef

doc/INSTALL.md Outdated Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved
Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
@niftynei
Copy link
Collaborator

niftynei commented Aug 4, 2022

ACK cdb27d9

@niftynei niftynei merged commit ffb3217 into ElementsProject:master Aug 4, 2022
@vincenzopalazzo vincenzopalazzo deleted the macros/split_dev_doc branch August 4, 2022 17:04
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.

4 participants