mirror of https://gitee.com/bigwinds/arangodb
don't make generation of README rely on html2text & markodwn executables (#10393)
This commit is contained in:
parent
c48747f631
commit
298fe7f27c
|
@ -772,8 +772,6 @@ if (USE_MAINTAINER_MODE)
|
|||
find_package(BISON)
|
||||
# these are required for generateREADME.sh
|
||||
find_program(FGREP_EXECUTABLE fgrep)
|
||||
find_program(MARKDOWN_EXECUTABLE markdown)
|
||||
find_program(HTML2TEXT_EXECUTABLE html2text)
|
||||
find_program(SED_EXECUTABLE sed)
|
||||
find_program(AWK_EXECUTABLE awk)
|
||||
endif ()
|
||||
|
|
116
README
116
README
|
@ -0,0 +1,116 @@
|
|||
ArangoDB
|
||||
========
|
||||
|
||||
|
||||
ArangoDB is a multi-model, open-source database with flexible data models for
|
||||
documents, graphs, and key-values. Build high performance applications using a
|
||||
convenient SQL-like query language or JavaScript extensions. Use ACID
|
||||
transactions if you require them. Scale horizontally with a few mouse clicks.
|
||||
|
||||
The supported data models can be mixed in queries and allow ArangoDB to be the
|
||||
aggregation point for your data.
|
||||
|
||||
To get started, try one of our 10 minutes [tutorials](https://www.arangodb.com/tutorials)
|
||||
in your favorite programming language or try one of our [ArangoDB Cookbook recipes](https://www.arangodb.com/docs/stable/cookbook/).
|
||||
|
||||
For the impatient: [download](https://www.arangodb.com/download) and install
|
||||
ArangoDB. Start the server `arangod` and point your browser to `http://127.0.0.1:8529/`.
|
||||
|
||||
Key Features in ArangoDB
|
||||
------------------------
|
||||
|
||||
- **Multi-Model**: Documents, graphs and key-value pairs — model your data as
|
||||
you see fit for your application.
|
||||
- **Joins**: Conveniently join what belongs together for flexible ad-hoc
|
||||
querying, less data redundancy.
|
||||
- **Transactions**: Easy application development keeping your data consistent
|
||||
and safe. No hassle in your client.
|
||||
|
||||
Here is an AQL query that makes use of all those features:
|
||||
|
||||

|
||||
|
||||
Joins and transactions are key features for flexible, secure data designs,
|
||||
widely used in relational databases but lacking in many NoSQL products. However,
|
||||
there is no need to forgo them in ArangoDB. You decide how and when to use joins
|
||||
and strong consistency guarantees, without sacrificing performance and scalability.
|
||||
|
||||
Furthermore, ArangoDB offers a JavaScript framework called [Foxx](https://www.arangodb.com/foxx)
|
||||
that is executed in the database server with direct access to the data. Build your
|
||||
own data-centric microservices with a few lines of code:
|
||||
|
||||
Microservice Example
|
||||
|
||||

|
||||
|
||||
By extending the HTTP API with user code written in JavaScript, ArangoDB can be
|
||||
turned into a strict schema-enforcing persistence engine.
|
||||
|
||||
Next step, bundle your Foxx application as a [docker container](https://www.arangodb.com/docs/stable/cookbook/cloud-node-js-docker.html)
|
||||
and get it running in the cloud.
|
||||
|
||||
Other features of ArangoDB include:
|
||||
|
||||
- Use a **data-centric microservices** approach with ArangoDB Foxx and fuse your
|
||||
application-logic and database together for maximal throughput
|
||||
- JavaScript for all: **no language zoo**, you can use one language from your
|
||||
browser to your back-end
|
||||
- **Flexible data modeling**: model your data as combination of key-value pairs,
|
||||
documents or graphs - perfect for social relations
|
||||
- Different **storage engines**: ArangoDB provides a storage engine for mostly
|
||||
in-memory operations and an alternative storage engine based on RocksDB which
|
||||
handle datasets that are much bigger than RAM.
|
||||
- **Powerful query language** (AQL) to retrieve and modify data
|
||||
- **Transactions**: run queries on multiple documents or collections with
|
||||
optional transactional consistency and isolation
|
||||
- **Replication** and **Sharding**: set up the database in a master-slave
|
||||
configuration or spread bigger datasets across multiple servers
|
||||
- Configurable **durability**: let the application decide if it needs more
|
||||
durability or more performance
|
||||
- **Schema-free schemata** let you combine the space efficiency of MySQL with the
|
||||
performance power of NoSQL
|
||||
- Free **index choice**: use the correct index for your problem, be it a skiplist
|
||||
or a fulltext search
|
||||
- ArangoDB is **multi-threaded** - exploit the power of all your cores
|
||||
- It is **open source** (Apache License 2.0)
|
||||
|
||||
For more in-depth information read the [design goals of ArangoDB](https://www.arangodb.com/2012/03/avocadodbs-design-objectives/)
|
||||
|
||||
|
||||
Latest Release
|
||||
--------------
|
||||
|
||||
Packages for all supported platforms can be downloaded from [https://www.arangodb.com/download](https://www.arangodb.com/download/).
|
||||
|
||||
Please also check [what's new in ArangoDB](https://www.arangodb.com/docs/stable/release-notes.html).
|
||||
|
||||
|
||||
More Information
|
||||
----------------
|
||||
|
||||
Please check the [Installation Manual](https://www.arangodb.com/docs/stable/installation.html)
|
||||
for installation and compilation instructions.
|
||||
|
||||
The [User Manual](https://www.arangodb.com/docs/stable/getting-started.html) has an
|
||||
introductory chapter showing the basic operations of ArangoDB.
|
||||
|
||||
|
||||
Stay in Contact
|
||||
---------------
|
||||
|
||||
We really appreciate feature requests and bug reports. Please use our Github
|
||||
issue tracker for reporting them:
|
||||
|
||||
[https://github.com/arangodb/arangodb/issues](https://github.com/arangodb/arangodb/issues)
|
||||
|
||||
You can use our Google group for improvements, feature requests, comments:
|
||||
|
||||
[https://www.arangodb.com/community](https://www.arangodb.com/community)
|
||||
|
||||
StackOverflow is great for questions about AQL, usage scenarios etc.
|
||||
|
||||
[https://stackoverflow.com/questions/tagged/arangodb](https://stackoverflow.com/questions/tagged/arangodb)
|
||||
|
||||
To chat with the community and the developers we offer a Slack chat:
|
||||
|
||||
[https://slack.arangodb.com/](https://slack.arangodb.com/)
|
|
@ -7,8 +7,6 @@ OUT=${2:-README}
|
|||
fgrep -v "[Build Status]" $IN \
|
||||
| fgrep -v "ArangoDB-Logo" \
|
||||
| fgrep -v "[Build Status]" \
|
||||
| markdown \
|
||||
| html2text -style compact -nobs \
|
||||
| sed -e 's:>:>:g' \
|
||||
| awk 'BEGIN { s = 0; } /^\*\*\*\*/ {if (s > 0) print ""} {if (length($0) == 0) {if (s != 0) print $0;} else {s = 1; print $0; }} /^\*\*\*\*/ {print ""}' \
|
||||
> $OUT
|
||||
|
|
Loading…
Reference in New Issue