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

Doc: Getting started, set up of dev environment. #218

Open
haru-02 opened this issue Feb 28, 2023 · 4 comments
Open

Doc: Getting started, set up of dev environment. #218

haru-02 opened this issue Feb 28, 2023 · 4 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@haru-02
Copy link

haru-02 commented Feb 28, 2023

Hello everyone,

New developer here looking to set up the dev environment to start contributing to the project. But i did not find the development documentation adequate to get started as a newcomer. I am planning to contribute and improve the "getting started" documentation for this project for now. So any help on how to get the dev env set up to code would be nice. I am using Linux mint 21. should i have debian 10 installed to contribute to this project ? or can i just run this on a VM ?

Thank you.

@haru-02 haru-02 added bug Something isn't working documentation Improvements or additions to documentation labels Feb 28, 2023
@Kixunil
Copy link
Collaborator

Kixunil commented Feb 28, 2023

Yeah, the state of dev doc is poor. :(

You can use VM just fine, in fact that's the primary development tool for me.
Please look at the CI script for now, it contains all the commands needed to set up the machine for building. You don't need to use additional container if you already have Debian 10 VM though.

(Note also that CI is broken, I have a solution but it's a bit involved, so I didn't get to implementing it.)

@haru-02
Copy link
Author

haru-02 commented Mar 2, 2023

thank you! i am checking out the CI script right now. Also, i only have 8gb of ram on my laptop. That should be fine for development right ?

@haru-02
Copy link
Author

haru-02 commented Mar 2, 2023

https://hollowmansblog.wordpress.com/2022/08/13/my-summer-of-bitcoin-2022-project-ci-for-cadr/

Also, is this the CI being referred to ? Thanks for clarifying :)

@Kixunil
Copy link
Collaborator

Kixunil commented Mar 3, 2023

Yes, my VMs have even less RAM. Lot of RAM is only required if you're trying to sync mainnet fast but 8G should be sufficient even for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants