Skip to content

Commit ea1a89a

Browse files
authored
Merge pull request #398 from hx2A/update_readmes
update readmes
2 parents 0c2ac09 + 48c89ef commit ea1a89a

File tree

2 files changed

+43
-26
lines changed

2 files changed

+43
-26
lines changed

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
[![Downloads](https://pepy.tech/badge/py5/week)](https://pepy.tech/project/py5)
88

9-
py5 is a version of [**Processing**][processing] for Python 3.8+. It makes the Java [**Processing**][processing] jars available to the CPython interpreter using [**JPype**][jpype]. It can do just about all of the 2D and 3D drawing [**Processing**][processing] can do, except with Python instead of Java code.
9+
py5 is a new version of [Processing][processing] for Python 3.8+. The goal of py5 is to create a version of Processing that is [integrated into the Python ecosystem](https://py5coding.org/integrations/python_ecosystem_integrations.html). Built into the library are thoughtful choices about how to best get py5 to work with other popular Python libraries and tools such as [Jupyter](https://jupyter.org/), [numpy](https://numpy.org/), [shapely](https://shapely.readthedocs.io/en/stable/), [trimesh](https://trimesh.org/), [matplotlib](https://matplotlib.org/), and [Pillow](https://python-pillow.org/).
1010

11-
The goal of py5 is to offer a new version of Processing that is integrated into the Python ecosystem. Built into the library are thoughtful choices about how to best get py5 to work with other popular Python libraries and tools such as [Jupyter][jupyter], [numpy][numpy], and [Pillow][pillow].
11+
py5 is an excellent choice for educators looking to teach Python in the context of creative coding and is currently used in classrooms all around the world. The documentation website includes [introductory tutorials](https://py5coding.org/tutorials/intro_to_py5_and_python.html) as well as extensive [reference documentation](https://py5coding.org/reference/summary.html), complete with example code.
1212

13-
## Simple Example
13+
## Basic Example
1414

15-
Here is a simple example of a working py5 Sketch, written in module mode:
15+
Here is a basic example of a working py5 Sketch:
1616

1717
```python3
1818
import py5
@@ -34,7 +34,7 @@ def mouse_clicked():
3434
py5.run_sketch()
3535
```
3636

37-
That creates a Sketch that looks like this:
37+
Here is an animated GIF to give you an idea of what that Sketch looks like:
3838

3939
![py5 example sketch](py5_docs/images/example.gif)
4040

@@ -46,10 +46,12 @@ If you have Java 17 installed on your computer, you can install py5 using pip:
4646
pip install py5
4747
```
4848

49-
[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/osx_users.html) that you should read if you use macOS.
49+
[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/macos_users.html) that you should read if you use macOS.
5050

5151
## Getting Started
5252

53+
If you are new to Python, start with the [](https://py5coding.org/tutorials/intro_to_py5_and_python.html) tutorials. If you are familiar with Java programming and Processing, you'll find the [](https://py5coding.org/content/coming_from_processing_java.html) page to be helpful.
54+
5355
There are currently five basic ways to use py5. They are:
5456

5557
* **module mode**: create a sketch with `setup()` and `draw()` functions that call methods provided by the `py5` library. The above example is created in module mode.
@@ -58,9 +60,19 @@ There are currently five basic ways to use py5. They are:
5860
* **static mode**: functionless code to create static images. This mode is supported by the py5bot Jupyter notebook kernel, the `%%py5bot` IPython magic, and the `run_sketch` command line utility.
5961
* **processing mode**: make calls to Python from a Processing (Java) Sketch. This mode enables py5 to function as bridge, connecting the Python and Java ecosystems through a new `callPython()` method.
6062

61-
The documentation website, [https://py5coding.org/](https://py5coding.org/), is a work in progress, but contains solid reference documentation and many tutorials for beginner coders.
63+
## Source Code
64+
65+
py5 was created by the artist and software developer [Jim Schmitz](https://ixora.io/) ([@hx2A](https://github.com/hx2A)) starting in March of 2020. The library is the foundation of his [art practice](https://ixora.io/art/).
66+
67+
The py5 library makes the Java Processing jars available to the CPython interpreter using [JPype][jpype]. It can do just about everything Processing can do, except with Python instead of Java code. New py5 features and bug fixes are being added to py5 every day. The library is always in active development and is well maintained.
68+
69+
To view the actual installed py5 library code, look at the [py5 repository][py5_repo]. The py5 library code is the output of the meta-programming project [py5generator][py5generator_repo]. All py5 development is done through [py5generator][py5generator_repo].
70+
71+
## Funding
6272

63-
py5generator is a meta-programming project that creates the py5 library. To view the actual installed py5 library code, look at the [py5 repository][py5_repo]. All py5 library development is done through py5generator.
73+
[Please sponsor py5!](https://github.com/sponsors/py5coding)
74+
75+
This project is not an official part of the Processing Foundation and is not receiving any funding from them. Any funds you contribute will be used first for website expenses and next to support [@hx2A](https://github.com/hx2A/)'s time to further develop py5 as a solid creative coding framework used by educators, artists, and hobbyists all around the world.
6476

6577
## Get In Touch
6678

@@ -71,10 +83,7 @@ Have a comment or question? We'd love to hear from you! The best ways to reach o
7183
* twitter [@py5coding](https://twitter.com/py5coding)
7284
* [processing foundation discourse](https://discourse.processing.org/)
7385

74-
[py5_repo]: https://github.com/py5coding/py5
7586
[processing]: https://github.com/processing/processing4
7687
[jpype]: https://github.com/jpype-project/jpype
77-
78-
[jupyter]: https://jupyter.org/
79-
[numpy]: https://numpy.org/
80-
[pillow]: https://python-pillow.org/
88+
[py5_repo]: https://github.com/py5coding/py5
89+
[py5generator_repo]: https://github.com/py5coding/py5generator

py5_resources/py5_module/README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
[![mybinder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/py5coding/py5examples/HEAD?urlpath=lab)
88

9-
py5 is a version of [**Processing**][processing] for Python 3.8+. It makes the Java [**Processing**][processing] jars available to the CPython interpreter using [**JPype**][jpype]. It can do just about all of the 2D and 3D drawing [**Processing**][processing] can do, except with Python instead of Java code.
9+
py5 is a new version of [Processing][processing] for Python 3.8+. The goal of py5 is to create a version of Processing that is [integrated into the Python ecosystem](https://py5coding.org/integrations/python_ecosystem_integrations.html). Built into the library are thoughtful choices about how to best get py5 to work with other popular Python libraries and tools such as [Jupyter](https://jupyter.org/), [numpy](https://numpy.org/), [shapely](https://shapely.readthedocs.io/en/stable/), [trimesh](https://trimesh.org/), [matplotlib](https://matplotlib.org/), and [Pillow](https://python-pillow.org/).
1010

11-
The goal of py5 is to offer a new version of Processing that is integrated into the Python ecosystem. Built into the library are thoughtful choices about how to best get py5 to work with other popular Python libraries and tools such as [Jupyter][jupyter], [numpy][numpy], and [Pillow][pillow].
11+
py5 is an excellent choice for educators looking to teach Python in the context of creative coding and is currently used in classrooms all around the world. The documentation website includes [introductory tutorials](https://py5coding.org/tutorials/intro_to_py5_and_python.html) as well as extensive [reference documentation](https://py5coding.org/reference/summary.html), complete with example code.
1212

13-
## Simple Example
13+
## Basic Example
1414

15-
Here is a simple example of a working py5 Sketch, written in module mode:
15+
Here is a basic example of a working py5 Sketch:
1616

1717
```python3
1818
import py5
@@ -42,10 +42,12 @@ If you have Java 17 installed on your computer, you can install py5 using pip:
4242
pip install py5
4343
```
4444

45-
[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/osx_users.html) that you should read if you use macOS.
45+
[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/macos_users.html) that you should read if you use macOS.
4646

4747
## Getting Started
4848

49+
If you are new to Python, start with the [](https://py5coding.org/tutorials/intro_to_py5_and_python.html) tutorials. If you are familiar with Java programming and Processing, you'll find the [](https://py5coding.org/content/coming_from_processing_java.html) page to be helpful.
50+
4951
There are currently five basic ways to use py5. They are:
5052

5153
* **module mode**: create a sketch with `setup()` and `draw()` functions that call methods provided by the `py5` library. The above example is created in module mode.
@@ -54,9 +56,19 @@ There are currently five basic ways to use py5. They are:
5456
* **static mode**: functionless code to create static images. This mode is supported by the py5bot Jupyter notebook kernel, the `%%py5bot` IPython magic, and the `run_sketch` command line utility.
5557
* **processing mode**: make calls to Python from a Processing (Java) Sketch. This mode enables py5 to function as bridge, connecting the Python and Java ecosystems through a new `callPython()` method.
5658

57-
The documentation website, [https://py5coding.org/](https://py5coding.org/), is a work in progress, but contains solid reference documentation and many tutorials for beginner coders.
59+
## Source Code
60+
61+
py5 was created by the artist and software developer [Jim Schmitz](https://ixora.io/) ([@hx2A](https://github.com/hx2A)) starting in March of 2020. The library is the foundation of his [art practice](https://ixora.io/art/).
62+
63+
The py5 library makes the Java Processing jars available to the CPython interpreter using [JPype][jpype]. It can do just about everything Processing can do, except with Python instead of Java code. New py5 features and bug fixes are being added to py5 every day. The library is always in active development and is well maintained.
64+
65+
To view the actual installed py5 library code, look at the [py5 repository][py5_repo]. The py5 library code is the output of the meta-programming project [py5generator][py5generator_repo]. All py5 development is done through [py5generator][py5generator_repo].
66+
67+
## Funding
5868

59-
[py5generator][py5_generator_repo] is a meta-programming project that creates the py5 library. To view the actual installed py5 library code, look at the [py5 repository][py5_repo]. All py5 library development is done through py5generator.
69+
[Please sponsor py5!](https://github.com/sponsors/py5coding)
70+
71+
This project is not an official part of the Processing Foundation and is not receiving any funding from them. Any funds you contribute will be used first for website expenses and next to support [@hx2A](https://github.com/hx2A/)'s time to further develop py5 as a solid creative coding framework used by educators, artists, and hobbyists all around the world.
6072

6173
## Get In Touch
6274

@@ -67,11 +79,7 @@ Have a comment or question? We'd love to hear from you! The best ways to reach o
6779
* twitter [@py5coding](https://twitter.com/py5coding)
6880
* [processing foundation discourse](https://discourse.processing.org/)
6981

70-
[py5_repo]: https://github.com/py5coding/py5
71-
[py5_generator_repo]: https://github.com/py5coding/py5generator
7282
[processing]: https://github.com/processing/processing4
7383
[jpype]: https://github.com/jpype-project/jpype
74-
75-
[jupyter]: https://jupyter.org/
76-
[numpy]: https://numpy.org/
77-
[pillow]: https://python-pillow.org/
84+
[py5_repo]: https://github.com/py5coding/py5
85+
[py5generator_repo]: https://github.com/py5coding/py5generator

0 commit comments

Comments
 (0)