search

sdatkinson / NeuralAmpModelerPlugin

Plugin for Neural Amp Modeler
MIT License
1.98k stars 132 forks source link

[DOCS] Detail getting started section for developers actualy run the project and contribute #323

Open gabrielucido opened 1 year ago

gabrielucido commented 1 year ago

Hello, I'm a developer and just get started to contribute to this project.

I wonder if there is a "Running project in development" docs. With that in mind, here's what would be nice to have when getting started on the project development.

  1. The project has submodules in it. Would be nice to have a link explaining how to fork the project about it and how to clone the repo including its submodules. I know this should be basic for developers but that's better safe than sorry I guess. Besides, would be nice to use this submodule section to talk about or to link to a section about its submodules, and why they were added to the project.

  2. How do I Run the project? I just cloned it, and initialized the submodules, so what? Can I run it on docker? Web? If I am using a mac as a development machine how would I run the application? Should I install a Lib?

  3. What's the recommended IDE's for development? I'm currently using VSCode, but for example what IDE Steve uses or recommend? There is a recommendation to be documented?

Describe the solution you'd like Include a WIKI or section in the CONTRIBUTING.md file that documents what's pointed in this issue about getting started in development.

Describe alternatives you've considered Does the repo will has a website with those docs or only the readme and other MD files? If so, would be a consideration.

I will try to keep this thread updated = )

gabrielucido commented 1 year ago

@sdatkinson Hello sr, good morning! I'm marking you here cause I forget to do it in the "3. What IDE can I use" section that I mentioned you. Also in general, you're the man! Would love to have your feedback about it = )

gabrielucido commented 1 year ago

About the development env, requirements, I think linking the docs of Iplug2 would work. For example here are the requirements for the development of the mac version of the plugin.

Getting Started MACOS

In this case they suggest to have a IO's compatible device, NAM does not support it, so would make sense to also have a short observation including what's Iplug2 requirements can be ignored in the context of the NAM plugin development.

sdatkinson commented 1 year ago

Since the requirements for getting started with this project are basically inherited from its parent frameworks (e.g. Submodules via Git, iPlug2), I'm happy to have this be solved by referencing those documentations that already exist. No need to re-invent the wheel, but I can see how that might make the onboarding process just a little easier.

@gabrielucido , would you like to be assigned this? A PR that provides the relevant info in the README would suffice. (better suited for there than CONTRIBUTING.md since folks may be interested in this, but not for the purpose of contributing back via PRs).