From cdd68a99ee027ac45218888e368fe7d0ff5eb44c Mon Sep 17 00:00:00 2001 From: Yi-Ting Tu Date: Wed, 11 Dec 2024 19:38:21 -0500 Subject: [PATCH] Update README and CONTRIBUTING --- CONTRIBUTING.md | 4 +++- README.md | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79d0aa8f..822726f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,9 @@ For direct contributions, see the following guidelines. ## Contributing translations -This project uses Weblate for translation (currently waiting for Libre hosting approval). Please visit https://hosted.weblate.org/projects/ray-optics-simulation/ to translate. +This project uses Weblate for translation (currently waiting for Libre hosting approval). Please visit https://hosted.weblate.org/engage/ray-optics-simulation/ to translate. + +[![Translation status](https://hosted.weblate.org/widget/ray-optics-simulation/287x66-grey.png)](https://hosted.weblate.org/engage/ray-optics-simulation/) If you already started the translation using the old json format before Dec 11, 2024, you can still submit that to ray-optics@phydemo.app (which will be converted to the new format by some automatic script). But please do not start a new translation with the old format. diff --git a/README.md b/README.md index cc8d004f..ec585ea8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Example figure](https://raw.githubusercontent.com/ricktu288/ray-optics/master/src/img/1.svg) +![Example figure](https://raw.githubusercontent.com/ricktu288/ray-optics/master/src/img/spherical-lens-and-mirror.jpg) # Ray Optics Simulation [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6386611.svg)](https://doi.org/10.5281/zenodo.6386611) @@ -48,7 +48,9 @@ Contributions are welcome. For the following types of contributions, no (or litt See [CONTRIBUTING.md](https://github.com/ricktu288/ray-optics/blob/master/CONTRIBUTING.md) for the tutorial. -For translations, note that this project uses Weblate (currently waiting for Libre hosting approval). Please visit https://hosted.weblate.org/projects/ray-optics-simulation/ to translate. +For translations, note that this project uses Weblate (currently waiting for Libre hosting approval). Please visit https://hosted.weblate.org/engage/ray-optics-simulation/ to translate. + +[![Translation status](https://hosted.weblate.org/widget/ray-optics-simulation/287x66-grey.png)](https://hosted.weblate.org/engage/ray-optics-simulation/) To contribute code, you need to have some knowledge of JavaScript and module bundling. The code is written in ES6 and bundled with Webpack. The code structure is documented in the [documentation](https://phydemo.app/ray-optics/docs/). See the following section for installation instructions.