Refinements for pub (#2)

* Changes to README * Updates: * Redirections from washington to github * CONTRIBUTING.md * README.md * Update Readme link * Update Contributors Co-authored-by: Joshua Jacobs <[email protected]>
joshicola · Mar 19, 2022 · 518e833 · 518e833
1 parent ffa6ac8
commit 518e833
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 22 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,14 @@
-Contributing
-============
+#Contributing
 
 1. Fork the repo, develop and test your code changes, add docs, add "constructions".
 2. Make sure that your commit messages clearly describe the changes.
 3. Send a pull request.
+
+## Editing the Messages_<lg>.properties file
+Translations are based on editing the `Messages_<lg>.properties` file for two-digit language codes.  Each of the language codes are listed in [Java's Supported Locales](https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html).
+
+To add your language follow the instructions above to include your `Messages_<lg>.properties` file in the pull request (where `<lg>` is the code for your language.)
+
+Use either the `source/Messages.properties` file or the `source/Playground.txt` file as a template.
+
+More explicit instructions are in the [wiki](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages).
diff --git a/README.md b/README.md
@@ -1,35 +1,69 @@
 # Geometry Playground
+Geometry Playground is a free ruler and compass Java application for multiple geometries.  
 
-Geometry Playground is a free ruler and compass Java application for multiple geometries. (You will need [Java 1.50](https://www.oracle.com/java/technologies/javase-downloads.html) or greater to run it.) To download Geometry Playground, follow the link below. Locate the `Playground.jar` in the download directory. Double-clicking the Playground.jar file will run Geometry Playground if the file is both set to "executable" and associated with a Java Runtime Executable. Alternatively, running the following command from a terminal prompt will do the same: `java -jar Playground.jar`.
+Follow the [instructions](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#installation-and-launch) to download and launch Geometry Playground.
 
-<center><font size="+2"> 
+## Language Translations
+Geometry Playground has been translated into [10 Languages](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages). To have it in your own language follow the [contributors guide](CONTRIBUTING.md) for changes to the `source/Messages.properties` file.
 
-[Geometry Playground](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[幾何学プレイグランド](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[Parque Geométrico](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[भूमिती अंगण](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[La Géométrie, une aire de jeux](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[الهندسة، مساحة ألعاب](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[기하 놀이마당](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[Геометрическая Игравая Плошадка](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[Geometria Játszótér](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
-[几何园地](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)
-</font></center>
 
-Instructions for Geometry Playground are probably not needed, but here is the general idea:
+## Basic Instructions for Use
+Barebones basic instructions for Geometry Playground are listed below:
 
 1.  Choose a geometry by selecting a tab.
 2.  Using the menus, choose what you want to do. You probably want to begin with the **Construct** menu.
 3.  Once you have chosen what you want to do, instructions for how to accomplish that should appear at the bottom of the screen.
 
 The command to "move stuff around" can be found in the **Manipulate** menu: **Transform** is the command.
 
+More in-depth instructions can be found in the accompanying [wiki pages](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#instructions-for-use).
+
+## Sample Constructions
 There are some [**constructions**](Constructions) of some traditional Euclidean constructions and their counterparts in other geometries. These [**constructions**](Constructions) are integrated into this repository.
 
+## Contributing
 For contributing improvements to Geometry Playground or additional [**constructions**](Constructions), please submit a pull request.  
 
+## References
+Geometry Playground was featured in the Mathematical Association of America's Loci
+Heath, Daniel and Joshua Jacobs,“Geometry Playground”, Loci (September 2010), DOI: [10.4169/loci003567](http://dx.doi.org/10.4169/loci003567).
+
+## Credits
 The original Java version of Geometry Playground is written by [D. Heath](https://github.com/deejHeath) and [J. Jacobs](https://github.com/joshicola).
 
+Language translations have been performed by many individuals including:
+* Arabic:
+  * Feryal Alayont
+  * Rachid Benkahlti
+* Chinese:
+  * Yachuan Yu
+  * Xioquian Zhang
+  * Qiang Zheng
+* French:
+  * Guillaume Lajoie
+* Hungarian:
+  * Laszlo Miklos Lovasz
+* Italian:
+  * Jeffrey Weeks
+* Japanese:
+  * Daniel J. Heath
+  * Yumiko Heath
+  * Hideto Tsutsui
+* Korean:
+  * Hyun-Jong Song
+  * Matthew Kim
+* Marathi:
+  * Ajit Datar
+* Russian:
+  * Natalya Manko
+  * Daniil Perebeynos
+* Spanish:
+  * Erlinda Cano
+  * Laura Matrajt
+
+<br>
+<br>
+<br>
 <center><font size="-2">
-Last updated 2021/03/28.
+Last updated 2022/03/18.
 </font></center>
diff --git a/ToDo.md b/ToDo.md
@@ -0,0 +1,3 @@
+# Get things done
+
+Done!
diff --git a/source/GeoPlayground.java b/source/GeoPlayground.java
@@ -777,7 +777,7 @@ else if (n==9 || n==7 || n==5 || n==-5) // if type=CircIntCirc01, CircIntLine1,
 			  }
     }
     if (e.getSource()==aboutMI) {
-    	BareBonesBrowserLaunch.openURL("https://students.washington.edu/josher/mediawiki/");
+    	BareBonesBrowserLaunch.openURL("https://github.com/joshicola/geometry_playground_java/wiki/Instructions");
     }
     for (int i=0;i<7;i++) if (e.getSource()==digitMI[i]) {
     	digitMI[digits-1].setText("");

diff --git a/source/Messages.properties b/source/Messages.properties
@@ -1,5 +1,5 @@
 //Translators:  More complete explanations of what the following lines of text are associated with,
-//              please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
+//              please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
 //              
 //              Only the text on the right needs to be translated.
 

diff --git a/source/Messages_hu.properties b/source/Messages_hu.properties
@@ -1,5 +1,5 @@
 //Translators:  More complete explanations of what the following lines of text are associated with,
-//              please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
+//              please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
 //              
 //              Only the text on the right needs to be translated.
 

diff --git a/source/Messages_it.properties b/source/Messages_it.properties
@@ -1,5 +1,5 @@
 //Translators:  More complete explanations of what the following lines of text are associated with,
-//              please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
+//              please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
 //
 //              Only the text on the right needs to be translated.
 

diff --git a/source/Playground.txt b/source/Playground.txt
@@ -1,5 +1,5 @@
 //Translators:  More complete explanations of what the following lines of text are associated with,
-//              please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
+//              please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
 //              
 //              Only the text on the right needs to be translated.