gavinbenda / platinum-md

Minidisc NetMD Conversion and Upload
MIT License
230 stars 38 forks source link

Please add compiling instructions under README.MD #150

Open longboarder241 opened 2 years ago

longboarder241 commented 2 years ago

since there was barely any info on how to build I assumed it was node js due to the addition of electron however doing an npm install bodes a ton of error messages about depreciated packages on both x86_64 and i686 architecture and thus leads to the failure to properly build. It'd be immensively helpful to add a section on building in that regard.

Shadester commented 2 years ago

https://github.com/gavinbenda/platinum-md/blob/master/testing.md

longboarder241 commented 2 years ago

https://github.com/gavinbenda/platinum-md/blob/master/testing.md

doing that results in this error; thomas-pc:[thomash]:~/git/platinum-md$ git checkout rh1-upload error: pathspec 'rh1-upload' did not match any file(s) known to git

Shadester commented 2 years ago

I would just use the master branch.

longboarder241 commented 2 years ago

I would just use the master branch.

how would that look as a command?

Shadester commented 2 years ago

git checkout master

gavinbenda commented 2 years ago

Yeah that README was more for development of backend features when working with the RH1.

I'll add a development README shortly, but it's actually quite straight forward! You need to have Yarn/NodeJS installed, and this is tested with Node 14 There might be some depreciation warnings, but it should still build.

> git clone https://github.com/gavinbenda/platinum-md
> cd platinum-md
> yarn
> yarn run dev
longboarder241 commented 2 years ago

Yeah that README was more for development of backend features when working with the RH1.

I'll add a development README shortly, but it's actually quite straight forward! You need to have Yarn/NodeJS installed, and this is tested with Node 14 There might be some depreciation warnings, but it should still build.

> git clone https://github.com/gavinbenda/platinum-md
> cd platinum-md
> yarn
> yarn run dev

Thanks! I really appreciate you adding the instructions as itd be really cool to see this adapted to even small devices like the Vaio P one day. Right now I'm compiling under a intel t2060. If I run into any issues I'll definitely let you know. Keep up the good work Gavin!