michitaro / healpix

An implementation of HEALPix in JavaScript / TypeScript
MIT License
13 stars 4 forks source link

Rewrite README #9

Closed cdeil closed 6 years ago

cdeil commented 6 years ago

@michitaro - This is an attempt to improve the README, following #6.

It's written more from the perspective of people new TS / JS, like me, focused on step by step commands to get started.

Specifically for the "isntall and use with npm" section I'm not sure if the description is accurate. Is it the same for TS / JS projects? Is this line correct (I didn't try yet)?

import { healpix } from 'healpix';

Or is this * import like in your examples needed? I'm just familiar with Python, where * imports are discouraged.

michitaro commented 6 years ago

Thank you very much!

Specifically for the "isntall and use with npm" section I'm not sure if the description is accurate. Is it the same for TS / JS projects? Is this line correct (I didn't try yet)?

import { healpix } from 'healpix';

I made a tiny change on it