Skip to content
This repository was archived by the owner on May 27, 2022. It is now read-only.

Commit 4a88653

Browse files
committed
More documentation language polishment, added trivia section.
Replaced "You can" etc with more formal stuff. IRC-Galleria "advertisement" has now a Trivia section at the very bottom of the document. I also added link to the mailing list at google groups. Removed [email protected].
1 parent bfb7969 commit 4a88653

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README

+25-21
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,10 @@ igbinary
44
Igbinary is a drop in replacement for the standard php serializer. Instead of
55
time and space consuming textual representation, igbinary stores php data
66
structures in a compact binary form. Savings are significant when using
7-
memcached or similar memory based storages for serialized data. You can
8-
expect about 50% reduction in storage requirement and speed is at least on par
9-
with the standard PHP serializer. Specific numbers depend on your data, of
10-
course.
11-
12-
But where does the name "igbinary" come from? There was once a similar project
13-
called fbinary but it has disappeared from the Internet a long time ago. Its
14-
architecture wasn't particularly clean either. IG is an abbreviation for a
15-
finnish social networking site IRC-Galleria (http://irc-galleria.net/)
7+
memcached or similar memory based storages for serialized data. About 50%
8+
reduction in storage requirement can be expected. Specific number depends on
9+
your data. (Un)serialization performance is at least on par with the standard
10+
PHP serializer.
1611

1712
Features
1813
--------
@@ -70,41 +65,50 @@ Installing
7065
----------
7166

7267
Note:
73-
Sometimes you may have to substitute phpize with phpize5.
74-
In such cases you probably should add "--with-php-config=.../php-config5" as
75-
an option to configure script.
68+
Sometimes phpize must be substituted with phpize5. In such cases the following
69+
option must be given to configure script: "--with-php-config=.../php-config5"
7670

7771
Compiling:
7872

7973
1. phpize
8074

81-
If you use GCC:
75+
With GCC:
8276
2. ./configure CFLAGS="-O2 -g" --enable-igbinary
8377

84-
If you use ICC (Intel C Compiler)
78+
With ICC (Intel C Compiler)
8579
2. ./configure CFLAGS=" -no-prec-div -O3 -xO -unroll2 -g" CC=icc --enable-igbinary
8680

8781
3. make
88-
4. ( make test)
82+
4. ( make test )
8983
5. make install
90-
6. igbinary.so is installed in the default extensions directory
84+
6. igbinary.so is installed to the default extension directory
9185

9286
Bugs & Contributions
9387
--------------------
9488

95-
To report bugs or to contribute fixes and improvements send email to
96-
opensource@dynamoid.com
89+
Mailing list for bug reports and other development discussion can be found
90+
at http://groups.google.com/group/igbinary
9791

98-
You can also fork at GitHub: http://github.com/dynamoid/igbinary
92+
The preferred ways for contributions are pull requests and email patches
93+
(in git format). Feel free to fork at http://github.com/dynamoid/igbinary
9994

10095
Utilizing in other extensions
10196
-----------------------------
10297

103-
You can call igbinary from other extensions fairly easily. Igbinary installs its
104-
header file to ext/igbinary/igbinary.h. There are just two straighforward
98+
Igbinary can be called from other extensions fairly easily. Igbinary installs
99+
its header file to ext/igbinary/igbinary.h. There are just two straighforward
105100
functions: igbinary_serialize and igbinary_unserialize. Look at igbinary.h for
106101
prototypes and usage.
107102

108103
Add PHP_ADD_EXTENSION_DEP(yourextension, igbinary) to your config.m4 in case
109104
someone wants to compile both of them statically into php.
110105

106+
Trivia
107+
------
108+
109+
Where does the name "igbinary" come from? There was once a similar project
110+
called fbinary but it has disappeared from the Internet a long time ago. Its
111+
architecture wasn't particularly clean either. IG is an abbreviation for a
112+
finnish social networking site IRC-Galleria (http://irc-galleria.net/)
113+
114+

0 commit comments

Comments
 (0)