snyk-tech-services / snyk2spdx

Other
14 stars 8 forks source link

I want snyk2spdx to provide some set up instructions #41

Open ronanbrowne opened 2 years ago

ronanbrowne commented 2 years ago

Describe expected behavior

README.md should contain install instructions. As far as i can see there is no released binary or artifact for this project, a user is expected to check out the code and build the code to use this. this implies implicit knowledge of NPM build systems.

A few lines on set up here would be appreciated for those of us without a node background.

I have checked out the project and ran a npm install but it is still unclear to me how to ran the tool from here.

lili2311 commented 2 years ago

hi @ronanbrowne, we are not actively working on this repository at this time. I am checking internally about any future plans here and will share this request.

caesartcs commented 2 years ago

@ronanbrowne I created a PR to explain how to build the binary.

https://github.com/snyk-tech-services/snyk2spdx/pull/50/commits/cca99b423ae4a90ae1e1b34c0ee12f43e97ac27e

More info on pkg can be found here

Hope this helps.