search

shashwatak / satellite-js

Modular set of functions for SGP4 and SDP4 propagation of TLEs.
MIT License
911 stars 145 forks source link

Added information on ES5 vs ES6+ #82

Closed thkruz closed 3 years ago

thkruz commented 3 years ago

As promised, took a stab at doing a pull request properly.

Just included a short summary of the discussion on ES5 vs ES6+ and why satellite.min.js isn't shown on the github page.

coveralls commented 3 years ago

Coverage Status

Coverage remained the same at 82.662% when pulling ea28d2581751c86dddb471f0264445a775435ecd on thkruz:update-readme into 4626ff52ad0934fa94e994252ef463a8c2af4d31 on shashwatak:develop.

davidcalhoun commented 3 years ago

Thanks for adding this clarification! I think some of the confusion is from folks who are no so familiar with npm. There is actually a missing step as well: running npm run build, which will output the /dist directory.

I checked out package.json and just saw a build that runs with prepublishOnly. An alternate solution: if this is changed to prepare, it will also run on npm install: https://docs.npmjs.com/cli/v6/using-npm/scripts, so folks wouldn't need to manually run npm run build.

EDIT: My bad, the readme has a Building section that explains how to build!

ezze commented 3 years ago

@thkruz Thanks a lot, mate!

@davidcalhoun Nice catch! We should consider to change prepublishOnly to prepare for those who are eager for old school approach without npm.

thkruz commented 3 years ago

Thanks for adding this clarification! I think some of the confusion is from folks who are no so familiar with npm.

@davidcalhoun 100% was my issue. Spent the last few days learning/implementing it after @ezze's explanation and now it all makes perfect sense.