Skip to content

Commit

Permalink
Update Readme (#309)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
dpdjvhxm authored Apr 18, 2024
1 parent 34590d2 commit 4d47f18
Showing 1 changed file with 41 additions and 4 deletions.
45 changes: 41 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,49 @@
# Apache AGE website
<h2><img height="30" src="https://age.apache.org/age-manual/master/_static/logo.png">&nbsp;&nbsp;Apache AGE website</h2>

## Introduction
<br>

<p align="center">
<img src="https://age.apache.org/age-manual/master/_static/logo.png" width="30%" height="30%">
</p>
<br>

<h3 align="center">
<a href="https://age.apache.org/age-manual/master/_static/logo.png" target="_blank">
<img src="https://age.apache.org/age-manual/master/_static/logo.png" height="25" height="30% alt="Apache AGE style="margin: 0 0 -3px 0">
</a>
<a href="https://age.apache.org/age-manual/master/_static/logo.png" target="_blank">
</a>
is a leading multi-model graph database </h3>
</h3>

<h3 align="center">Graph Processing & Analytics for Relational Databases</h3>

<br>


</br>

This repository provides the source for the main [website of The Apache AGE](https://age.apache.org/).<br/>
<br/>
The link below contains the following Apache AGE project:
* [The Apache AGE Project](https://github.com/apache/age)
* [The Apache AGE Viewer Project](https://github.com/apache/age-viewer)





<h2><img height="30" src="https://github.com/apache/age/raw/master/img/tick.svg">&nbsp;&nbsp;Introduction</h2>

* The `master` branch contains the source code of the latest version of the documentation.
* `vX.Y.Z` Branches contain the source code of the documentation of releases.
* The `asf-site` branch contains the static webpage code, as well as the build static version of the documenation (in the `docs` folder). The `docs` folder should not be manually updated.
* `new-web` branch is where website development work is done.


<h2><img height="30" src="https://github.com/apache/age/raw/master/img/installation.svg">&nbsp;&nbsp;Build the documentation locally (first time)</h2>

## Build the documentation locally (first time)

* Install requirements (the latex and dvisvgm commands are required to display math)

Expand Down Expand Up @@ -57,7 +94,7 @@ pip install -r requirements.txt

The documentation for the current local branch should now be in the `build/html/current` folder (no subfolders).

## Build documentation locally (after initial setup)
<h2><img height="30" src="https://github.com/apache/age/raw/master/img/installation.svg">&nbsp;&nbsp;Build documentation locally (after initial setup)</h2>

* Navigate to the root of the repository

Expand Down

0 comments on commit 4d47f18

Please sign in to comment.