Skip to content

Commit 7a08ea9

Browse files
committed
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.
1 parent 9e27e6c commit 7a08ea9

File tree

4 files changed

+25
-28
lines changed

4 files changed

+25
-28
lines changed

.travis.yml

+2-10
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,8 @@ os: linux
66

77
env:
88
global:
9-
- 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/
10-
- MARIADB_TAR=mariadb-5.5.48-linux-glibc_214-x86_64.tar.gz
11-
- MARIADB_DIR=mariadb-5.5.48-linux-x86_64
129
- secure: "kfzqiIq1XhZ89XYsnqFhPKr5UWB+W4fYAYpOYOLgWMmqfjwqQTm1nN/A6TuFmdbTrzB6hLawsxIUrPS+QKs4TI8tTQMRZ8IZV4TIUQVa7SNQljwrKvnSu0fSoqpPrvXxjEjbTlvpo7X5EKCyCB0Xz6NaYVJIvE9bYnwCEAJw30k="
1310

14-
15-
# prepare the environment
16-
before_script:
17-
# get mariadb packages from mariadb.org
18-
- chmod +x .travis/download_mariadb.sh
19-
- .travis/download_mariadb.sh
20-
2111
# actual compilation commands
2212
script:
2313
- chmod +x .travis/build_maxscale.sh
@@ -31,6 +21,8 @@ addons:
3121
- libpcre3-dev
3222
- doxygen
3323
- pandoc
24+
- uuid
25+
- uuid-dev
3426
coverity_scan:
3527
project:
3628
name: "mariadb-corporation/MaxScale"

.travis/build_maxscale.sh

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@
88

99

1010
echo TRAVIS_BUILD_DIR: ${TRAVIS_BUILD_DIR}
11-
echo MARIADB_DIR: ${MARIADB_DIR}
1211

1312
mkdir build
1413
cd build
1514

16-
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
15+
cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=Y -DBUILD_AVRO=N
1716

18-
make VERBOSE=1
17+
make
18+
make test
1919
sudo make install
20-
sudo make testcore
2120

2221
sudo ./postinst
2322
maxscale --version

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ if(WITH_MAXSCALE_CNF)
266266
endif()
267267
install(FILES server/maxscale_binlogserver_template.cnf DESTINATION ${MAXSCALE_SHAREDIR})
268268
install(FILES ${CMAKE_SOURCE_DIR}/COPYRIGHT DESTINATION ${MAXSCALE_SHAREDIR})
269-
install(FILES ${CMAKE_SOURCE_DIR}/README DESTINATION ${MAXSCALE_SHAREDIR})
269+
install(FILES ${CMAKE_SOURCE_DIR}/README.md DESTINATION ${MAXSCALE_SHAREDIR})
270270
install(FILES ${CMAKE_SOURCE_DIR}/LICENSE.TXT DESTINATION ${MAXSCALE_SHAREDIR})
271271
install(FILES etc/lsyncd_example.conf DESTINATION ${MAXSCALE_SHAREDIR})
272272
install(FILES Documentation/maxscale.1 DESTINATION ${CMAKE_INSTALL_DATADIR}/man/man1)

README README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MaxScale by MariaDB Corporation
22

3+
[![Build Status](https://travis-ci.org/mariadb-corporation/MaxScale.svg?branch=2.0)](https://travis-ci.org/mariadb-corporation/MaxScale)
4+
35
The MariaDB Corporation MaxScale is an intelligent proxy that allows
46
forwarding of database statements to one or more database servers using
57
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.
2628
An Google Group exists for MaxScale that can be used to discuss ideas,
2729
issues and communicate with the MaxScale community.
2830

29-
30-
Forum: http://groups.google.com/forum/#!forum/maxscale
31+
32+
- Forum: http://groups.google.com/forum/#!forum/maxscale
33+
34+
We're also on the #maria and #maxscale channels on FreeNode.
3135

32-
Bugs can be reported in the MariaDB Corporation bugs database:
33-
https://jira.mariadb.org/projects/MXS/issues
36+
Please report all feature requests, improvements and bugs in the [MariaDB Jira](https://jira.mariadb.org/projects/MXS/issues).
3437

3538
# Documentation
3639

3740
For information about installing and using MaxScale, please refer to the
38-
documentation. It is in Markdown format.
41+
documentation. The official documentation can be found on the
42+
[MariaDB Knowledge Base](https://mariadb.com/kb/en/mariadb-enterprise/maxscale/).
43+
44+
- [MariaDB MaxScale 2.0 Documentation](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-20-contents/)
45+
- [MariaDB MaxScale 1.4 Documentation](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-14/maxscale-maxscale-contents/)
46+
47+
The module and configuration documentation can be found in the _Documentation_
48+
directory of the source tree.
3949

40-
You can point your browser to the MaxScale project at GitHub. Look
41-
inside the "Documentation" directory, where you will find a file named
42-
Documentation-Contents.md. Click on that, and GitHub will show the
43-
documentation in its intended display format. The contents page lists
44-
the available documents and has links to them.
50+
# Contributing Code
4551

46-
If you do not want to rely on the internet, then clone the project
47-
from GitHub and point your browser to the Documentation-Contents.md
48-
file in your local file system and proceed as above.
52+
Read the [Contributing](https://github.com/mariadb-corporation/MaxScale/wiki/Contributing)
53+
page on the wiki for more information on how to do pull request and where to do
54+
them.

0 commit comments

Comments
 (0)