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

Update readme #25

Merged
merged 10 commits into from
Oct 8, 2024
Merged

Update readme #25

merged 10 commits into from
Oct 8, 2024

Conversation

neo-garaix
Copy link
Contributor

Fix

  • Replaced favicon.ico file because there was a problem with the initial file.

Update

  • In the README.md at the root of the project, I moved the compiling/build text because this README goes in the package when we build it.

Add

  • CONTRIBUTING.md file with the compiling/build text do it doesn't go in the package.
  • Add a link to the repository in README.md so people on the package's website can know where's the repository.

@dmarteau
Copy link
Member

dmarteau commented Oct 3, 2024

We are mixing things here, this is source code for proj4rs, and informations for building WASM package is not really a contributing info.

The README also goes to Rust crate repository https://crates.io/crates/proj4rs so it should not be the same as for the npm package. Imho, you should rename CONTRIBUTING to something more specific - i.e README_WASM.md or similar.

@neo-garaix
Copy link
Contributor Author

So the README_WASM.md should be a file that people can read if they want to build proj4rs locally to modify/test things ?
Because this project will use the project4rs package directly through npm from the internet.

Concerning the initial README.md, whether it is on crates.io or on the npm's website, I don't really understand why we could not have same README.
Instead of writing "Contributing" at the end of It, I can put a link to the README_WASM.md and explain that we can build it locally to modify/test things.
I can wait the package to be up on npm, modify the source code of demos (to use the online package instead of the local one), then modify the different README like I said above ?

@dmarteau
Copy link
Member

dmarteau commented Oct 3, 2024

Because this project will use the project4rs package directly through npm from the internet.

Can you elaborate ? Alll js demo of this repository are for testing purpose and must use the locally build package, not a package loaded from npm.

@dmarteau
Copy link
Member

dmarteau commented Oct 3, 2024

So the README_WASM.md should be a file that people can read if they want to build proj4rs locally to modify/test things

Yes

I don't really understand why we could not have same README.

We can use the the same readme if the content is relevant for both user of the rust package and those of the npm package.

@Gustry Gustry self-requested a review October 4, 2024 08:56
Copy link
Member

@Gustry Gustry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor review about Markdown syntax ;-)

CONTRIBUTING.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README_WASM.md Show resolved Hide resolved
README_WASM.md Outdated Show resolved Hide resolved
README_WASM.md Outdated Show resolved Hide resolved
@dmarteau dmarteau merged commit 100ad54 into 3liz:main Oct 8, 2024
1 check passed
@neo-garaix neo-garaix deleted the dev branch October 8, 2024 14:59
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.

3 participants