Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Edit pass on README.md |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
7df3201d4f5787337a7063557426eb17 |
User & Date: | tangent 2020-07-10 19:28:52.086 |
Context
2020-07-10
| ||
20:14 | Markdown tweak for Fossil's renderer check-in: e9f50a9293 user: tangent tags: trunk | |
19:28 | Edit pass on README.md check-in: 7df3201d4f user: tangent tags: trunk | |
19:15 | Doc updates in HACKERS.md, primarily to the info about Fossil. check-in: 96f1657f60 user: tangent tags: trunk | |
Changes
Changes to README.md.
1 2 3 | # What It Is MySQL++ is a C++ wrapper for the MySQL and MariaDB C APIs. It is built | | | | | | | < | | | | > | < | > | > > | | < | | | > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | # What It Is MySQL++ is a C++ wrapper for the MySQL and MariaDB C APIs. It is built on the same principles as the Standard C++ Library to make dealing with the database as easy as dealing with `std` containers. MySQL++ also provides facilities that let you avoid the most repetitive sorts of SQL within your own code, providing native C++ interfaces for these common tasks. 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 To build MySQL++, you must have the MySQL/MariaDB C API development files installed. On Unixy systems — Linux, macOS, Cygwin, \*BSD, Solaris... — you are most likely using a binary MySQL/MariaDB package where the server, client, and development pieces are packaged separately. The package containing the development files is typically called something like `MySQL-devel`, `libmysqlclient-dev`, etc. If you're building on Windows with Visual C++ or MinGW, you need to install the native Windows port of MySQL or MariaDB. That includes the development files in the installer, but depending on how it was built, those files might not be installed by default. You might have to select a “complete” or “custom” install to get what you need to build MySQL++ against that version of MySQL/MariaDB. Another common pitfall is that the Windows installers install MySQL/MariaDB to a path with the version number embedded, which means we cannot ship a single set of build system files that works with all versions. We simply point at the General Availability version of MySQL/MariaDB at the time of release, which may well be different from the version installed on your computer. You will have to adjust the link and include file paths in the build system files accordingly. # 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++ itself, see [the HACKERS.md 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]. 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. [dgm]: https://www.doxygen.nl/manual/ [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/ [umr]: https://tangentsoft.com/mysqlpp/doc/trunk/doc/userman/README.md # Building the Library MySQL++ uses [Bakefile](http://bakefile.org/) to generate platform-specific project files and makefiles from a single set of input files. We currently support these build systems: |
︙ | ︙ | |||
114 115 116 117 118 119 120 | You may want to try out the programs in the examples subdirectory to ensure that the MySQL++ API and your MySQL database are both working properly. Also, [these examples][exr] give many examples of the proper use of MySQL++. [exr]: /doc/trunk/README-examples.txt | < < < < < < < < < < < < < < < < | 123 124 125 126 127 128 129 | You may want to try out the programs in the examples subdirectory to ensure that the MySQL++ API and your MySQL database are both working properly. Also, [these examples][exr] give many examples of the proper use of MySQL++. [exr]: /doc/trunk/README-examples.txt |