Change README to Markdown and fix Travis for 2.0
Converting the README into Markdown format makes it a lot easier to comprehent. Also cleaned up the formatting. The 2.0 branch had a broken Travis configuration. Fixed it and changed links to point to 2.0 branch.
This commit is contained in:

committed by
Markus Mäkelä

parent
9e27e6c002
commit
7a08ea99af
12
.travis.yml
12
.travis.yml
@ -6,18 +6,8 @@ os: linux
|
|||||||
|
|
||||||
env:
|
env:
|
||||||
global:
|
global:
|
||||||
- MARIADB_URL=https://downloads.mariadb.org/interstitial/mariadb-5.5.48/bintar-linux-glibc_214-x86_64/mariadb-5.5.48-linux-glibc_214-x86_64.tar.gz/from/http%3A//mirror.netinch.com/pub/mariadb/
|
|
||||||
- MARIADB_TAR=mariadb-5.5.48-linux-glibc_214-x86_64.tar.gz
|
|
||||||
- MARIADB_DIR=mariadb-5.5.48-linux-x86_64
|
|
||||||
- secure: "kfzqiIq1XhZ89XYsnqFhPKr5UWB+W4fYAYpOYOLgWMmqfjwqQTm1nN/A6TuFmdbTrzB6hLawsxIUrPS+QKs4TI8tTQMRZ8IZV4TIUQVa7SNQljwrKvnSu0fSoqpPrvXxjEjbTlvpo7X5EKCyCB0Xz6NaYVJIvE9bYnwCEAJw30k="
|
- secure: "kfzqiIq1XhZ89XYsnqFhPKr5UWB+W4fYAYpOYOLgWMmqfjwqQTm1nN/A6TuFmdbTrzB6hLawsxIUrPS+QKs4TI8tTQMRZ8IZV4TIUQVa7SNQljwrKvnSu0fSoqpPrvXxjEjbTlvpo7X5EKCyCB0Xz6NaYVJIvE9bYnwCEAJw30k="
|
||||||
|
|
||||||
|
|
||||||
# prepare the environment
|
|
||||||
before_script:
|
|
||||||
# get mariadb packages from mariadb.org
|
|
||||||
- chmod +x .travis/download_mariadb.sh
|
|
||||||
- .travis/download_mariadb.sh
|
|
||||||
|
|
||||||
# actual compilation commands
|
# actual compilation commands
|
||||||
script:
|
script:
|
||||||
- chmod +x .travis/build_maxscale.sh
|
- chmod +x .travis/build_maxscale.sh
|
||||||
@ -31,6 +21,8 @@ addons:
|
|||||||
- libpcre3-dev
|
- libpcre3-dev
|
||||||
- doxygen
|
- doxygen
|
||||||
- pandoc
|
- pandoc
|
||||||
|
- uuid
|
||||||
|
- uuid-dev
|
||||||
coverity_scan:
|
coverity_scan:
|
||||||
project:
|
project:
|
||||||
name: "mariadb-corporation/MaxScale"
|
name: "mariadb-corporation/MaxScale"
|
||||||
|
@ -8,16 +8,15 @@
|
|||||||
|
|
||||||
|
|
||||||
echo TRAVIS_BUILD_DIR: ${TRAVIS_BUILD_DIR}
|
echo TRAVIS_BUILD_DIR: ${TRAVIS_BUILD_DIR}
|
||||||
echo MARIADB_DIR: ${MARIADB_DIR}
|
|
||||||
|
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
|
|
||||||
cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DMYSQL_EMBEDDED_INCLUDE_DIR=${TRAVIS_BUILD_DIR}/${MARIADB_DIR}/include/ -DMYSQL_EMBEDDED_LIBRARIES=${TRAVIS_BUILD_DIR}/${MARIADB_DIR}/lib/libmysqld.a -DERRMSG=${TRAVIS_BUILD_DIR}/${MARIADB_DIR}/share/english/errmsg.sys
|
cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=Y -DBUILD_AVRO=N
|
||||||
|
|
||||||
make VERBOSE=1
|
make
|
||||||
|
make test
|
||||||
sudo make install
|
sudo make install
|
||||||
sudo make testcore
|
|
||||||
|
|
||||||
sudo ./postinst
|
sudo ./postinst
|
||||||
maxscale --version
|
maxscale --version
|
||||||
|
@ -266,7 +266,7 @@ if(WITH_MAXSCALE_CNF)
|
|||||||
endif()
|
endif()
|
||||||
install(FILES server/maxscale_binlogserver_template.cnf DESTINATION ${MAXSCALE_SHAREDIR})
|
install(FILES server/maxscale_binlogserver_template.cnf DESTINATION ${MAXSCALE_SHAREDIR})
|
||||||
install(FILES ${CMAKE_SOURCE_DIR}/COPYRIGHT DESTINATION ${MAXSCALE_SHAREDIR})
|
install(FILES ${CMAKE_SOURCE_DIR}/COPYRIGHT DESTINATION ${MAXSCALE_SHAREDIR})
|
||||||
install(FILES ${CMAKE_SOURCE_DIR}/README DESTINATION ${MAXSCALE_SHAREDIR})
|
install(FILES ${CMAKE_SOURCE_DIR}/README.md DESTINATION ${MAXSCALE_SHAREDIR})
|
||||||
install(FILES ${CMAKE_SOURCE_DIR}/LICENSE.TXT DESTINATION ${MAXSCALE_SHAREDIR})
|
install(FILES ${CMAKE_SOURCE_DIR}/LICENSE.TXT DESTINATION ${MAXSCALE_SHAREDIR})
|
||||||
install(FILES etc/lsyncd_example.conf DESTINATION ${MAXSCALE_SHAREDIR})
|
install(FILES etc/lsyncd_example.conf DESTINATION ${MAXSCALE_SHAREDIR})
|
||||||
install(FILES Documentation/maxscale.1 DESTINATION ${CMAKE_INSTALL_DATADIR}/man/man1)
|
install(FILES Documentation/maxscale.1 DESTINATION ${CMAKE_INSTALL_DATADIR}/man/man1)
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
# MaxScale by MariaDB Corporation
|
# MaxScale by MariaDB Corporation
|
||||||
|
|
||||||
|
[](https://travis-ci.org/mariadb-corporation/MaxScale)
|
||||||
|
|
||||||
The MariaDB Corporation MaxScale is an intelligent proxy that allows
|
The MariaDB Corporation MaxScale is an intelligent proxy that allows
|
||||||
forwarding of database statements to one or more database servers using
|
forwarding of database statements to one or more database servers using
|
||||||
complex rules, a semantic understanding of the database statements and the
|
complex rules, a semantic understanding of the database statements and the
|
||||||
@ -26,23 +28,27 @@ as external shared objects and are referred to as routing modules.
|
|||||||
An Google Group exists for MaxScale that can be used to discuss ideas,
|
An Google Group exists for MaxScale that can be used to discuss ideas,
|
||||||
issues and communicate with the MaxScale community.
|
issues and communicate with the MaxScale community.
|
||||||
|
|
||||||
Email: maxscale@googlegroups.com
|
- Email: maxscale@googlegroups.com
|
||||||
Forum: http://groups.google.com/forum/#!forum/maxscale
|
- Forum: http://groups.google.com/forum/#!forum/maxscale
|
||||||
|
|
||||||
Bugs can be reported in the MariaDB Corporation bugs database:
|
We're also on the #maria and #maxscale channels on FreeNode.
|
||||||
https://jira.mariadb.org/projects/MXS/issues
|
|
||||||
|
Please report all feature requests, improvements and bugs in the [MariaDB Jira](https://jira.mariadb.org/projects/MXS/issues).
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
|
|
||||||
For information about installing and using MaxScale, please refer to the
|
For information about installing and using MaxScale, please refer to the
|
||||||
documentation. It is in Markdown format.
|
documentation. The official documentation can be found on the
|
||||||
|
[MariaDB Knowledge Base](https://mariadb.com/kb/en/mariadb-enterprise/maxscale/).
|
||||||
|
|
||||||
You can point your browser to the MaxScale project at GitHub. Look
|
- [MariaDB MaxScale 2.0 Documentation](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-20-contents/)
|
||||||
inside the "Documentation" directory, where you will find a file named
|
- [MariaDB MaxScale 1.4 Documentation](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-14/maxscale-maxscale-contents/)
|
||||||
Documentation-Contents.md. Click on that, and GitHub will show the
|
|
||||||
documentation in its intended display format. The contents page lists
|
|
||||||
the available documents and has links to them.
|
|
||||||
|
|
||||||
If you do not want to rely on the internet, then clone the project
|
The module and configuration documentation can be found in the _Documentation_
|
||||||
from GitHub and point your browser to the Documentation-Contents.md
|
directory of the source tree.
|
||||||
file in your local file system and proceed as above.
|
|
||||||
|
# Contributing Code
|
||||||
|
|
||||||
|
Read the [Contributing](https://github.com/mariadb-corporation/MaxScale/wiki/Contributing)
|
||||||
|
page on the wiki for more information on how to do pull request and where to do
|
||||||
|
them.
|
Reference in New Issue
Block a user