moved translation doc to wiki
Massimo Melina committed
Mar 16, 2023 at 10:26 UTC
0fdaedd7ed317a4578783d2abc10ab2d0bc1b56f
1 file changed
+16
-30
README.md
+16
-30
@@ -260,45 +260,31 @@ This is enough, but you may want to configure generated links accordingly:
260
261
There are several ways to contribute
262
263
-### Report bugs
263
+- [Report bugs](https://github.com/rejetto/hfs/issues/new?labels=bug&template=bug_report.md)
264
265
-It's very important to report bugs.
266
-If you see something you are quite sure it's a problem, then [open an issue](https://github.com/rejetto/hfs/issues/new?labels=bug&template=bug_report.md).
267
-If you are not so sure, don't worry, we'll discuss it.
265
+ It's very important to report bugs, and if you are not so sure about it, don't worry, we'll discuss it.
266
+ If you find important security problems, please [contact us privately](mailto:a@rejetto.com) so that we can publish a fix before
267
+ the problem is disclosed, for the safety of other users.
268
269
-### Suggest ideas
269
+- [Translate to your language](https://github.com/rejetto/hfs/wiki/Translation).
270
271
-Share your ideas of what you think would make this tool better.
272
-Don't expect everything to be done, tho, as this project is made on a voluntary basis,
273
-and also because the project could become too complex (too many features).
271
+- [Suggest ideas](https://github.com/rejetto/hfs/discussions)
272
275
-Anyway, secondary features may be implemented by plugins instead. Yours may be an idea for a plugin.
273
+ While the project should not become too complex, yours may be an idea for a plugin.
274
277
-### Translate to your language
275
+- Submit your code
276
279
-First, check if your language is already available, looking at [this list](https://github.com/rejetto/hfs/tree/main/langs).
277
+ If you'd like to make a change yourself in the code, please first open an "issue" or "discussion" about it,
278
+ so we'll try to cooperate and understand what's the best path for it.
279
281
-If your language is missing, [download then english file](https://raw.githubusercontent.com/rejetto/hfs/main/langs/hfs-lang-en.json) as a starting point.
282
-Rename the file changing the "en" part with [your language's 2-letter code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
280
+- [Make a plugin](https://github.com/rejetto/hfs/blob/main/dev-plugins.md)
281
284
-The file syntax is JSON, and the translation syntax is ICU. When you see curly braces like `{n}`,
285
-that's a variable, like a number, always changing. Commands within curly braces MUST NOT be translated,
286
-like `plural`.
282
+ A plugin can change the look (a theme), and/or introduce a new functionality.
283
288
-The way plural works in your language is probably different from english, so if you don't get the results you need,
289
-you may need to make some changes.
290
-[Refer to this guide](https://formatjs.io/docs/core-concepts/icu-syntax/#plural-format) to know your options.
284
+## More
285
292
-Always check your file is working good before submitting.
293
-When you are sure it's good, you can publish it. The easiest way is to [open an issue](https://github.com/rejetto/hfs/issues/new)
294
-and attach your file (you may need to zip it, first).
295
-We will include it in our folder.
286
+- [Build yourself](https://github.com/rejetto/hfs/blob/main/dev.md)
287
297
-### Submit your code
288
+- [License](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
289
299
-If you'd like to make a change yourself in the code, please first open an "issue" or "discussion" about it,
300
-so we'll try to cooperate and understand what's the best path for it.
301
-
302
-## License
303
-
304
-[GPLv3](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
290
+- [To-do list](https://github.com/rejetto/hfs/blob/main/todo.md)
\ No newline at end of file