MySQL++

Check-in [0102b7250b]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Updates to README.md to take advantage of its new Markdown formatting and to account for the fact that it might be mirrored on GitHub where Fossil-relative repo links no longer work.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256:0102b7250b4d22005db76755f7d8a2b2e8a5b094d84addc6d861d7e060c6a99c
User & Date: tangent 2019-05-11 11:09:14
Context
2019-05-11
11:43
Converted the user manual's README file to Markdown check-in: d56fa32aec user: tangent tags: trunk
11:09
Updates to README.md to take advantage of its new Markdown formatting and to account for the fact that it might be mirrored on GitHub where Fossil-relative repo links no longer work. check-in: 0102b7250b user: tangent tags: trunk
2019-04-22
19:38
Converted top-level README.txt file to Markdown so it formats more nicely on GitHub and in the Fossil /file view. check-in: d080820431 user: tangent tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to README.md.

5
6
7
8
9
10
11
12


13
14
15
16
17
18
19
..
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63





64
65
66
67
68
69
70
..
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
...
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
dealing with an STL container.  MySQL++ relieves the programmer of
dealing with cumbersome C data structures, generation of repetitive SQL
statements, and manual creation of C++ data structures to mirror the
database schema.

MySQL++’s development home is its [Fossil repository][home]. You may be
reading this via its [GitHub mirror][ghm], but that repository is
read-only, meant only for use with automation tooling based on Git.



[ghm]:  https://github.com/tangentsoft/mysqlpp
[home]: https://tangentsoft.com/mysqlpp/


# Prerequisites

................................................................................

# Additional Things to Read

Each major platform we support has a dedicated `README-*.txt`
file for it containing information specific to that platform.
Please read it.

For authorship information, see the CREDITS.txt file.

For license information, see the COPYING.txt file.

If you want to change MySQL++, see the HACKERS.md file.

You should have received a user manual and a reference manual
with MySQL++.  If not, you can read a recent version online:

    https://tangentsoft.com/mysqlpp/doc/

Search the MySQL++ [mailing list archives][ml] and [its forum][for] if
you have more questions.






[for]:  https://tangentsoft.com/mysqlpp/froum/
[ml]:   http://lists.mysql.com/plusplus/


# Building the Library

MySQL++ uses [Bakefile](http://bakefile.org/) to generate
................................................................................
    though the result sometimes requires manual adjustment. No older
    version of Visual C++ will build MySQL++, due to compiler
    limitations.  See [its README][vcpp] for more details.

*   **Xcode:** We ship an Xcode project file, but it hasn't been well
    tested, since the autoconf method works just fine on macOS.

[cyg]:   /doc/trunk/README-Cygwin.txt
[linux]: /doc/trunk/README-Linux.txt
[macos]: /doc/trunk/README-Mac-OS-X.txt
[mingw]: /doc/trunk/README-MinGW.txt
[sol]:   /doc/trunk/README-Solaris.txt
[unix]:  /doc/trunk/README-Unix.txt
[vcpp]:  /doc/trunk/README-Visual-C%2B%2B.txt



# Example Programs

You may want to try out the programs in the examples subdirectory
to ensure that the MySQL++ API and your MySQL database are both
................................................................................
On Unixy systems, GCC still works best.  "Native" compilers and
third-party compilers may work, but you're on your own to get
it working.

We have nothing in particular against these unsupported systems.
We just lack the time and resources to support everything
ourselves.  If you are sufficiently motivated to get MySQL++
working on one of these alternate systems, see [the HACKERS file][hack]
for guidance.  If you follow the advice in that file,
your patch will be more likely to be accepted.

[hack]: /doc/trunk/HACKERS.md


# If You Want to Hack on MySQL++...

If you intend to submit a change to the MySQL++ project, see
[the HACKERS file][hack].

If you want to change the MySQL++ user manual, also read
[the user manual’s README][umr].

If you want to change the MySQL++ reference manual, see
[the Doxygen manual][dgm].


[dgm]: http://www.doxygen.nl/manual/
[umr]: /doc/trunk/doc/userman/README.txt







|
>
>







 







|

|

|

|
|
<
<




>
>
>
>
>







 







|
|
|
|
|
|
|







 







|



<
<




|









|
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
..
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
..
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
...
123
124
125
126
127
128
129
130
131
132
133


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
dealing with an STL container.  MySQL++ relieves the programmer of
dealing with cumbersome C data structures, generation of repetitive SQL
statements, and manual creation of C++ data structures to mirror the
database schema.

MySQL++’s development home is its [Fossil repository][home]. You may be
reading this via its [GitHub mirror][ghm], but that repository is
read-only, meant as a download-only mirror and for use by automation
tooling based on Git. Checkins to the Fossil repository get pushed
into the GitHub mirror within a day.

[ghm]:  https://github.com/tangentsoft/mysqlpp
[home]: https://tangentsoft.com/mysqlpp/


# Prerequisites

................................................................................

# Additional Things to Read

Each major platform we support has a dedicated `README-*.txt`
file for it containing information specific to that platform.
Please read it.

For authorship information, see [the CREDITS.txt file][f1].

For license information, see [the COPYING.txt file][f2].

If you want to change MySQL++, see [the HACKERS.md file][f3].

You should have received a user manual and a reference manual with
MySQL++. If not, you can read a recent version [online][docs].



Search the MySQL++ [mailing list archives][ml] and [its forum][for] if
you have more questions.


[docs]: https://tangentsoft.com/mysqlpp/doc/
[f1]:   https://tangentsoft.com/mysqlpp/doc/trunk/CREDITS.txt
[f2]:   https://tangentsoft.com/mysqlpp/doc/trunk/COPYING.txt
[f3]:   https://tangentsoft.com/mysqlpp/doc/trunk/HACKERS.md
[for]:  https://tangentsoft.com/mysqlpp/froum/
[ml]:   http://lists.mysql.com/plusplus/


# Building the Library

MySQL++ uses [Bakefile](http://bakefile.org/) to generate
................................................................................
    though the result sometimes requires manual adjustment. No older
    version of Visual C++ will build MySQL++, due to compiler
    limitations.  See [its README][vcpp] for more details.

*   **Xcode:** We ship an Xcode project file, but it hasn't been well
    tested, since the autoconf method works just fine on macOS.

[cyg]:   https://tangentsoft.com/mysqlpp/doc/trunk/README-Cygwin.txt
[linux]: https://tangentsoft.com/mysqlpp/doc/trunk/README-Linux.txt
[macos]: https://tangentsoft.com/mysqlpp/doc/trunk/README-Mac-OS-X.txt
[mingw]: https://tangentsoft.com/mysqlpp/doc/trunk/README-MinGW.txt
[sol]:   https://tangentsoft.com/mysqlpp/doc/trunk/README-Solaris.txt
[unix]:  https://tangentsoft.com/mysqlpp/doc/trunk/README-Unix.txt
[vcpp]:  https://tangentsoft.com/mysqlpp/doc/trunk/README-Visual-C%2B%2B.txt



# Example Programs

You may want to try out the programs in the examples subdirectory
to ensure that the MySQL++ API and your MySQL database are both
................................................................................
On Unixy systems, GCC still works best.  "Native" compilers and
third-party compilers may work, but you're on your own to get
it working.

We have nothing in particular against these unsupported systems.
We just lack the time and resources to support everything
ourselves.  If you are sufficiently motivated to get MySQL++
working on one of these alternate systems, see [the HACKERS file][f3]
for guidance.  If you follow the advice in that file,
your patch will be more likely to be accepted.




# If You Want to Hack on MySQL++...

If you intend to submit a change to the MySQL++ project, see
[the HACKERS file][f3].

If you want to change the MySQL++ user manual, also read
[the user manual’s README][umr].

If you want to change the MySQL++ reference manual, see
[the Doxygen manual][dgm].


[dgm]: http://www.doxygen.nl/manual/
[umr]: https://tangentsoft.com/mysqlpp/doc/trunk/doc/userman/README.txt