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

Fixing installation issues and updating readme to address the issue, #2999

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

xXxSpicyBoiiixXx
Copy link

@xXxSpicyBoiiixXx xXxSpicyBoiiixXx commented Jun 11, 2024

Description

(insert summary)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@elegantmoose elegantmoose self-assigned this Jul 1, 2024
@elegantmoose
Copy link
Contributor

@xXxSpicyBoiiixXx , few notes:

  • I noted some typos
  • This may be better fit in the Magma repo, as node specific.
  • @clenk , thoughts? Im on the fence as this is very general to node, not Caldera.

@clenk
Copy link
Contributor

clenk commented Jul 2, 2024

What specific issues were encountered?

Maybe the readme just needs to mention npm as a requirement, like
* NodeJS (v16+ recommended) and npm
It's included in Node, but we can make it explicit.

More detailed instructions like this should go in fieldmanual in my opinion.

@xXxSpicyBoiiixXx
Copy link
Author

I was downloading this on some Linux machines I have, there was some issues with node but I think making it explicit would be nice in the readme. I would agree it's not caldera specific but it does leverage node, but I still had to update all that and it was a bit of work to get caldera to work properly without it noted.

@clenk
Copy link
Contributor

clenk commented Jul 4, 2024

Any chance you can remember which versions of npm/node were giving you errors?

@xXxSpicyBoiiixXx
Copy link
Author

I'm not sure about the version, but the latest one works.

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.

None yet

3 participants