Skip to content

Commit 518e833

Browse files
joshicolaJoshua Jacobs
andauthored
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 <joshua.jacobs@mayo.edu>
1 parent ffa6ac8 commit 518e833

File tree

8 files changed

+67
-22
lines changed

8 files changed

+67
-22
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
Contributing
2-
============
1+
#Contributing
32

43
1. Fork the repo, develop and test your code changes, add docs, add "constructions".
54
2. Make sure that your commit messages clearly describe the changes.
65
3. Send a pull request.
6+
7+
## Editing the Messages_<lg>.properties file
8+
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).
9+
10+
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.)
11+
12+
Use either the `source/Messages.properties` file or the `source/Playground.txt` file as a template.
13+
14+
More explicit instructions are in the [wiki](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages).

README.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,69 @@
11
# Geometry Playground
2+
Geometry Playground is a free ruler and compass Java application for multiple geometries.
23

3-
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`.
4+
Follow the [instructions](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#installation-and-launch) to download and launch Geometry Playground.
45

5-
<center><font size="+2">
6+
## Language Translations
7+
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.
68

7-
[Geometry Playground](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
8-
[幾何学プレイグランド](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
9-
[Parque Geométrico](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
10-
[भूमिती अंगण](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
11-
[La Géométrie, une aire de jeux](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
12-
[الهندسة، مساحة ألعاب](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
13-
[기하 놀이마당](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
14-
[Геометрическая Игравая Плошадка](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
15-
[Geometria Játszótér](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)<br>
16-
[几何园地](https://github.com/joshicola/geometry_playground_java/releases/latest/download/Playground.jar)
17-
</font></center>
189

19-
Instructions for Geometry Playground are probably not needed, but here is the general idea:
10+
## Basic Instructions for Use
11+
Barebones basic instructions for Geometry Playground are listed below:
2012

2113
1. Choose a geometry by selecting a tab.
2214
2. Using the menus, choose what you want to do. You probably want to begin with the **Construct** menu.
2315
3. Once you have chosen what you want to do, instructions for how to accomplish that should appear at the bottom of the screen.
2416

2517
The command to "move stuff around" can be found in the **Manipulate** menu: **Transform** is the command.
2618

19+
More in-depth instructions can be found in the accompanying [wiki pages](https://github.com/joshicola/geometry_playground_java/wiki/Instructions#instructions-for-use).
20+
21+
## Sample Constructions
2722
There are some [**constructions**](Constructions) of some traditional Euclidean constructions and their counterparts in other geometries. These [**constructions**](Constructions) are integrated into this repository.
2823

24+
## Contributing
2925
For contributing improvements to Geometry Playground or additional [**constructions**](Constructions), please submit a pull request.
3026

27+
## References
28+
Geometry Playground was featured in the Mathematical Association of America's Loci
29+
Heath, Daniel and Joshua Jacobs,“Geometry Playground”, Loci (September 2010), DOI: [10.4169/loci003567](http://dx.doi.org/10.4169/loci003567).
30+
31+
## Credits
3132
The original Java version of Geometry Playground is written by [D. Heath](https://github.com/deejHeath) and [J. Jacobs](https://github.com/joshicola).
3233

34+
Language translations have been performed by many individuals including:
35+
* Arabic:
36+
* Feryal Alayont
37+
* Rachid Benkahlti
38+
* Chinese:
39+
* Yachuan Yu
40+
* Xioquian Zhang
41+
* Qiang Zheng
42+
* French:
43+
* Guillaume Lajoie
44+
* Hungarian:
45+
* Laszlo Miklos Lovasz
46+
* Italian:
47+
* Jeffrey Weeks
48+
* Japanese:
49+
* Daniel J. Heath
50+
* Yumiko Heath
51+
* Hideto Tsutsui
52+
* Korean:
53+
* Hyun-Jong Song
54+
* Matthew Kim
55+
* Marathi:
56+
* Ajit Datar
57+
* Russian:
58+
* Natalya Manko
59+
* Daniil Perebeynos
60+
* Spanish:
61+
* Erlinda Cano
62+
* Laura Matrajt
63+
64+
<br>
65+
<br>
66+
<br>
3367
<center><font size="-2">
34-
Last updated 2021/03/28.
68+
Last updated 2022/03/18.
3569
</font></center>

ToDo.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Get things done
2+
3+
Done!

source/GeoPlayground.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ else if (n==9 || n==7 || n==5 || n==-5) // if type=CircIntCirc01, CircIntLine1,
777777
}
778778
}
779779
if (e.getSource()==aboutMI) {
780-
BareBonesBrowserLaunch.openURL("https://students.washington.edu/josher/mediawiki/");
780+
BareBonesBrowserLaunch.openURL("https://github.com/joshicola/geometry_playground_java/wiki/Instructions");
781781
}
782782
for (int i=0;i<7;i++) if (e.getSource()==digitMI[i]) {
783783
digitMI[digits-1].setText("");

source/Messages.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//Translators: More complete explanations of what the following lines of text are associated with,
2-
// please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
2+
// please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
33
//
44
// Only the text on the right needs to be translated.
55

source/Messages_hu.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//Translators: More complete explanations of what the following lines of text are associated with,
2-
// please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
2+
// please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
33
//
44
// Only the text on the right needs to be translated.
55

source/Messages_it.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//Translators: More complete explanations of what the following lines of text are associated with,
2-
// please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
2+
// please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
33
//
44
// Only the text on the right needs to be translated.
55

source/Playground.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//Translators: More complete explanations of what the following lines of text are associated with,
2-
// please look at http://students.washington.edu/josher/mediawiki/index.php?title=Instructions.
2+
// please look at https://github.com/joshicola/geometry_playground_java/wiki/Instructions#languages.
33
//
44
// Only the text on the right needs to be translated.
55

0 commit comments

Comments
 (0)