mudhorn/zxing
1
0
Fork 0
mirror of https://github.com/zxing/zxing.git synced 2024-11-09 20:44:03 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity
zxing/README.md

103 lines
6.7 KiB
Markdown
Raw Normal View History

Added logo
2014-01-20 12:10:20 -08:00
<img align="right" src="https://raw.github.com/wiki/zxing/zxing/zxing-logo.png"/>
Clarify project is in maintenance mode
2018-11-27 12:44:49 -08:00
## Project in Maintenance Mode Only
The project is in maintenance mode, meaning, changes are driven by contributed patches.
Only bug fixes and minor enhancements will be considered. The Barcode Scanner app can
no longer be published, so it's unlikely any changes will be accepted for it.
There is otherwise no active development or roadmap for this project. It is "DIY".
Small readme fixes (#782)
2017-04-04 22:37:31 -07:00
## Get Started Developing
Add note about Play store removal
2019-02-10 09:55:58 -08:00
Added the "Get Started" link in the README.md It is really hard to find the instruction.
2016-01-28 16:53:58 -08:00
To get started, please visit: https://github.com/zxing/zxing/wiki/Getting-Started-Developing
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
ZXing ("zebra crossing") is an open-source, multi-format 1D/2D barcode image processing
library implemented in Java, with ports to other languages.
## Supported Formats
Add note about UPC/EAN extension 2/5
2020-01-30 05:14:22 -08:00
| 1D product | 1D industrial | 2D |
|:----------------------|:--------------|:---------------|
| UPC-A | Code 39 | QR Code |
| UPC-E | Code 93 | Data Matrix |
Remove reference to 'beta' quality formats
2020-07-15 13:14:10 -07:00
| EAN-8 | Code 128 | Aztec |
| EAN-13 | Codabar | PDF 417 |
Add note about UPC/EAN extension 2/5
2020-01-30 05:14:22 -08:00
| UPC/EAN Extension 2/5 | ITF | MaxiCode |
| | | RSS-14 |
| | | RSS-Expanded |
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
## Components
### Active
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
| Module | Description
| ------------------- | -----------
| core | The core image decoding library, and test code
| javase | JavaSE-specific client code
Updated Google Play badge. Closes #892
2017-10-18 01:05:02 -07:00
| android | Android client Barcode Scanner [<img height='62' width='161' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'/>](https://play.google.com/store/apps/details?id=com.google.zxing.client.android)
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
| android-integration | Supports integration with Barcode Scanner via `Intent`
Update site version, use HTTPS more in docs
2017-04-23 07:41:33 -07:00
| android-core | Android-related code shared among `android`, other Android apps
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
| zxingorg | The source behind `zxing.org`
| zxing.appspot.com | The source behind web-based barcode generator at `zxing.appspot.com`
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
### Available in previous releases
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
| Module | Description
| ------ | -----------
Retire actionscript
2014-04-30 01:06:06 -07:00
| [cpp](https://github.com/zxing/zxing/tree/00f634024ceeee591f54e6984ea7dd666fab22ae/cpp) | C++ port
| [iphone](https://github.com/zxing/zxing/tree/00f634024ceeee591f54e6984ea7dd666fab22ae/iphone) | iPhone client
| [objc](https://github.com/zxing/zxing/tree/00f634024ceeee591f54e6984ea7dd666fab22ae/objc) | Objective C port
| [actionscript](https://github.com/zxing/zxing/tree/c1df162b95e07928afbd4830798cc1408af1ac67/actionscript) | Partial ActionScript port
Update note on jruby
2015-01-11 08:18:32 -08:00
| [jruby](https://github.com/zxing/zxing/tree/a95a8fee842f67fb43799a8e0e70e4c68b509c43/jruby) | JRuby wrapper
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
Update note on jruby
2015-01-11 08:18:32 -08:00
### ZXing-based third-party open source projects
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
Add nu-book/zxing-cpp
2018-12-17 09:28:49 -08:00
| Module | Description
| ----------------------------------------------------------------------------------------- | -----------
Update README.md: Add SCodes Qt/Qml wrapper library link (#1518)
2022-04-29 05:53:05 -07:00
| [SCodes](https://github.com/scytheStudio/SCodes) | Qt & Qml wrapper
Add nu-book/zxing-cpp
2018-12-17 09:28:49 -08:00
| [QZXing](https://github.com/ftylitak/qzxing) | port to Qt framework
| [glassechidna/zxing-cpp](https://github.com/glassechidna/zxing-cpp) | port to C++ (forked from the [deprecated official C++ port](https://github.com/zxing/zxing/tree/00f634024ceeee591f54e6984ea7dd666fab22ae/cpp))
update nu-book/zxing-cpp link (#1557) nu-book/zxing-cpp is now reachable under zxing-cpp/zxing-cpp
2022-08-24 15:45:11 -07:00
| [zxing-cpp/zxing-cpp](https://github.com/zxing-cpp/zxing-cpp) | latest/active port to C++, includes Android, iOS, Python, WASM and WinRT wrappers
Add nu-book/zxing-cpp
2018-12-17 09:28:49 -08:00
| [zxing_cpp.rb](https://github.com/glassechidna/zxing_cpp.rb) | bindings for Ruby (not just JRuby), powered by [zxing-cpp](https://github.com/glassechidna/zxing-cpp)
| [jsqrcode](https://github.com/LazarSoft/jsqrcode) | port to JavaScript
| [python-zxing](https://github.com/oostendo/python-zxing) | bindings for Python
| [ZXing .NET](https://github.com/micjahn/ZXing.Net) | port to .NET and C#, and related Windows platform
| [php-qrcode-detector-decoder](https://github.com/khanamiryan/php-qrcode-detector-decoder) | port to PHP
| [ZXing Delphi](https://github.com/Spelt/ZXing.Delphi) | Port to native Delphi object pascal, targeted at Firemonkey compatible devices (IOS/Android/Win/OSX) and VCL.
| [ZXingObjC](https://github.com/TheLevelUp/ZXingObjC) | Port to Objective-C
| [php-zxing](https://github.com/dsiddharth2/php-zxing) | PHP wrapper to Zxing Java library
| [zxing-js/library](https://github.com/zxing-js/library) | TypeScript port of ZXing library
add a Python wrapper to ZXing library (#1290) add pyzxing in ZXing-based third-party open source projects table
2020-05-28 20:29:01 -07:00
| [pyzxing](https://github.com/ChenjieXu/pyzxing) | Python wrapper to ZXing library
Add zxing-dart link (#1558)
2022-08-24 18:34:36 -07:00
| [zxing-dart](https://github.com/shirne/zxing-dart) | Port to dart
add rust port (#1588)
2023-01-08 20:06:01 -08:00
| [rxing](https://github.com/hschimke/rxing) | Port to rust
Change README.md. Added Delphi/Pascal ZXing reference. (#718)
2016-12-03 01:10:38 -08:00
Update note on jruby
2015-01-11 08:18:32 -08:00
### Other related third-party open source projects
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
Remove deprecated glass-mirror
2014-02-26 13:59:26 -08:00
| Module | Description
| ---------------------------------------------- | -----------
Correct "Other third-party open source projects".
2014-11-27 05:49:40 -08:00
| [Barcode4J](http://barcode4j.sourceforge.net/) | Generator library in Java
Update README.md (#1485) Added BoofCV to related third-party open source projects
2022-01-18 16:31:45 -08:00
| [BoofCV](https://boofcv.org) | Generator and reader library in Java
Correct "Other third-party open source projects".
2014-11-27 05:49:40 -08:00
| [ZBar](http://zbar.sourceforge.net/) | Reader library in C99
Add description for OkapiBarcode project (#1545)
2022-07-19 16:36:01 -07:00
| [OkapiBarcode](https://github.com/woo-j/OkapiBarcode) | Generator library in Java |
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
Port links to resources from code.google.com/p/zxing
2014-01-18 05:56:32 -08:00
## Links
Various code tweaks, action updates, dep updates
2022-10-20 12:13:34 -07:00
* [Online Decoder](https://zxing.org/w/decode.jspx)
* [QR Code Generator](https://zxing.appspot.com/generator)
* [Javadoc](https://zxing.github.io/zxing/apidocs/)
* [Documentation Site](https://zxing.github.io/zxing/)
Port links to resources from code.google.com/p/zxing
2014-01-18 05:56:32 -08:00
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
## Contacting
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
Post to the [discussion forum](https://groups.google.com/group/zxing) or tag a question with [`zxing`
Update site version, use HTTPS more in docs
2017-04-23 07:41:33 -07:00
on StackOverflow](https://stackoverflow.com/questions/tagged/zxing).
Port code.google.com/p/zxing page to Github README.md, take 1
2014-01-17 02:44:03 -08:00
## Etcetera
Various code tweaks, action updates, dep updates
2022-10-20 12:13:34 -07:00
[![codecov](https://codecov.io/gh/zxing/zxing/branch/master/graph/badge.svg?token=6RrJHvUMDl)](https://codecov.io/gh/zxing/zxing)
[![Codacy](https://app.codacy.com/project/badge/Grade/5d1186edeb714f0187e3eb18cc6aeef1)](https://www.codacy.com/gh/zxing/zxing/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=zxing/zxing&amp;utm_campaign=Badge_Grade)
Point to new docs location at zxing.github.io and stop deploying javadoc to zxing.org
2014-01-22 10:41:04 -08:00
Port code.google.com/p/zxing page to Github README.md, take 2
2014-01-17 02:52:04 -08:00
QR code is trademarked by Denso Wave, inc. Thanks to Haase & Martin OHG for contributing the logo.
Point to new docs location at zxing.github.io and stop deploying javadoc to zxing.org
2014-01-22 10:41:04 -08:00
Update site version, use HTTPS more in docs
2017-04-23 07:41:33 -07:00
Optimized with [![JProfiler](https://www.ej-technologies.com/images/banners/jprofiler_small.png)](https://www.ej-technologies.com/products/jprofiler/overview.html)
Reference in a new issue Copy permalink