daniel-norris / neu_ui

Prototype and build projects faster using Neu UI - an open source React component library designed to neumorphic style. Built using React, Styled Components, Jest and Storybook.
https://ui-neu.netlify.app/
MIT License
24 stars 31 forks source link

Create README translations #25

Open daniel-norris opened 3 years ago

daniel-norris commented 3 years ago

Is your feature request related to a problem? Please describe. There isn't localisation options for the readme for most users.

Describe the solution you'd like Additional translations of the README into other languages.

Current readme translations:

Tititesouris commented 3 years ago

Hello @daniel-norris I'll give a go at translating it in French

daniel-norris commented 3 years ago

Hey @Tititesouris thanks for offering to contribute. It's assigned to you 😊

Tititesouris commented 3 years ago

Hey @daniel-norris I have a few questions and remarks:

Thanks :)

natastro commented 3 years ago

Hello! Happy to help with Spanish translations if needed :) Thank you!

daniel-norris commented 3 years ago

Hello! Happy to help with Spanish translations if needed :) Thank you!

Hey @natastro, that would be awesome. Thankyou 😊

daniel-norris commented 3 years ago

Hey @Tititesouris, sorry for the delay in replying to you. Answers below:

I went with the polite form of "you". Even if in tech it would not bother anyone to be addressed in the non-polite form, I believe it reads more naturally for descriptions/instructions. That sounds fine to me.

What are props in the context "Docs are available and include information on props, how to start contributing and a contribution guide. Props are... well Props. They're passed to components built in React just like you would pass an input to a function in Javascript. The React docs in French actually just refer to them as "Props" too. So you're probably safe to literally translate it to French as "props". See the docs here

In the english README, I noticed a discrepancy between the title of the section "licence" and the section name in the contents: "license", I am guessing this is a mistake :) I had a quick look but couldn't find this? If there's a discrepancy in the docs, you're probably right though and its more than likely a typo or grammatical error.

In the sentence "The initial components have now been converted and extended to include a whole suite of initial controlled form and card components into a React library.", what does "initial controlled" mean? Also is it saying "suite of (initial controlled form) AND (card components)" or "suite of initial controlled (form AND card) components"?

Controlled components typically refer to forms or more specifically form elements that accept inputs from the user. The React docs again will help shed a bit more light on this but a common way to describe this kind of behaviour in React 😊.

The README in English could probably do with a bit of updating but when they were originally written, we only had a very small selection (or initial set) of components. I guess you could read it as form AND card components or form components AND card components.

Hope that helps. You can find out more about controlled components here.

Tititesouris commented 3 years ago

Hey @Tititesouris, sorry for the delay in replying to you. Answers below:

I went with the polite form of "you". Even if in tech it would not bother anyone to be addressed in the non-polite form, I believe it reads more naturally for descriptions/instructions. That sounds fine to me.

What are props in the context "Docs are available and include information on props, how to start contributing and a contribution guide. Props are... well Props. They're passed to components built in React just like you would pass an input to a function in Javascript. The React docs in French actually just refer to them as "Props" too. So you're probably safe to literally translate it to French as "props". See the docs here

In the english README, I noticed a discrepancy between the title of the section "licence" and the section name in the contents: "license", I am guessing this is a mistake :) I had a quick look but couldn't find this? If there's a discrepancy in the docs, you're probably right though and its more than likely a typo or grammatical error.

In the sentence "The initial components have now been converted and extended to include a whole suite of initial controlled form and card components into a React library.", what does "initial controlled" mean? Also is it saying "suite of (initial controlled form) AND (card components)" or "suite of initial controlled (form AND card) components"?

Controlled components typically refer to forms or more specifically form elements that accept inputs from the user. The React docs again will help shed a bit more light on this but a common way to describe this kind of behaviour in React 😊.

The README in English could probably do with a bit of updating but when they were originally written, we only had a very small selection (or initial set) of components. I guess you could read it as form AND card components or form components AND card components.

Hope that helps. You can find out more about controlled components here.

Thanks for the answers, I'll work on it as soon as I can. This is what I mean by licence in the english README, I would suggest the following change: image

s0meon3 commented 3 years ago

Hey! I would like to work on a translation to Brazilian Portuguese if that's ok :)

daniel-norris commented 3 years ago

Hey @s0meon3 I think someone has just beaten you to it I'm afraid. You're welcome to submit a PR for anything else though.

@Tititesouris, those changes look fine to me.

Tititesouris commented 3 years ago

Here's the French PR #46, plus a bonus 2 fixed typos

xstable commented 3 years ago

You can assign me to the german one.

SerekKiri commented 3 years ago

Added polish one in https://github.com/daniel-norris/neu_ui/pull/89 😄