forked from BaseXdb/basex
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
78 lines (53 loc) · 2.86 KB
/
readme.txt
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
======================================================= BASEX README ===
Welcome to the source code of BaseX.
To get the project running as smooth as possible, please consider the
following notes:
COMPILING BASEX --------------------------------------------------------
JDK 1.6 and JUnit is currently needed to compile the complete sources
of the main project. If you are using another environment than Eclipse
or don't have JUnit installed, just delete the 'test' package inside
the project and rebuild the project.
See http://docs.basex.org/wiki/Maven for information on how to use Maven.
You can launch the following classes, which are all placed in the main
package org.basex:
BaseX : console mode
BaseXServer : server instance, waiting for requests
BaseXClient : console mode, interacting with the server
BaseXGUI : graphical user interface
Moreover, try -h to list the available command line options. For
example, you can use BaseX to process XQuery expressions without
entering the console.
USING ECLIPSE ----------------------------------------------------------
BaseX is being developed with the Eclipse environment. Some style
guidelines are integrated in the sources of BaseX; they are being
embedded as soon as you open the project.
RUNNING BASEX ----------------------------------------------------------
The following steps can be performed to start BaseX with Eclipse:
- Press Run -> Run...
- Create a new "Java Application" launch configuration
- Select "basex" as "Project"
- Choose a "Main class" (e.g., org.basex.BaseXGUI)
- Launch the project via 'Run'
ADDING CHECKSTYLE ------------------------------------------------------
Some additional Checkstyle guidelines are defined in the project:
- Open Eclipse
- Press "Help" -> "Install new Software..."
- Press "Search for new features to install"
- Enter the URL: http://eclipse-cs.sourceforge.net/update
- Follow the installation procedure and restart Eclipse
USING GIT --------------------------------------------------------------
The code base of BaseX can be accessed via GitHub (www.github.com):
- Main Package: http://github.com/BaseXdb/basex
- APIs: REST, WebDAV, XML:DB, XQJ: http://github.com/BaseXdb/basex-api
- Examples: http://github.com/BaseXdb/basex-examples
- Tests, Stress Tests: http://github.com/BaseXdb/basex-tests
------------------------------------------------------------------------
Any kind of feedback is welcome; please check out the documentation at
http://docs.basex.org
Tell us if you run into any troubles installing BaseX:
You are as well invited to contribute to our bug tracker:
https://github.com/BaseXdb/BaseX/issues
All the best,
BaseX Team, 2011
========================================================================