Skip to content

Commit d429a6e

Browse files
authored
Update README with license and documentation badges
Added badges for license and documentation to README.
1 parent b8ef134 commit d429a6e

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

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

33
C++ Mode for Processing. Write sketches with `setup()` and `draw()` inside the Processing IDE, or drop the engine into your own C++ project and use the same API from your own editor and build system.
44

5+
[![License: LGPL v2.1](https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg)](LICENSE)
6+
[![Docs](https://img.shields.io/badge/docs-processing--cpp.github.io-orange)](https://processing-cpp.github.io)
7+
58
---
69

710
## Two ways to use it
@@ -11,6 +14,7 @@ C++ Mode for Processing. Write sketches with `setup()` and `draw()` inside the P
1114
If you know Processing, this is the fastest way in. Install C++ Mode through the Contribution Manager, select it from the mode dropdown, and write sketches exactly like you normally would. They compile to native C++ instead of Java, but the workflow is identical.
1215

1316
**Install:**
17+
1418
1. Open Processing
1519
2. Click the mode dropdown (top right, says **Java** by default) → **Add Mode...**
1620
3. Search for **C++ Mode** and click Install
@@ -78,6 +82,7 @@ Get the latest release from the [releases page](https://github.com/processing-cp
7882
## Requirements
7983

8084
### Windows
85+
8186
MSYS2 with MinGW 64-bit. Install once:
8287

8388
```bash
@@ -87,6 +92,7 @@ pacman -S --needed mingw-w64-x86_64-gcc mingw-w64-x86_64-glfw mingw-w64-x86_64-g
8792
Always build from the **MSYS2 MinGW 64-bit** terminal, not PowerShell or Command Prompt.
8893

8994
### macOS
95+
9096
Xcode command line tools and Homebrew:
9197

9298
```bash
@@ -95,6 +101,7 @@ brew install glfw glew
95101
```
96102

97103
### Linux
104+
98105
```bash
99106
# Ubuntu / Debian
100107
sudo apt install g++ libglfw3-dev libglew-dev
@@ -117,6 +124,12 @@ Full reference and tutorials at [processing-cpp.github.io](https://processing-cp
117124

118125
---
119126

127+
## Contributing
128+
129+
Contributions are welcome. Open an issue or pull request on [GitHub](https://github.com/processing-cpp/processing.cpp).
130+
131+
---
132+
120133
## License
121134

122135
[LGPL-2.1](LICENSE)

0 commit comments

Comments
 (0)