From 5640ce1c9cd62c293f9b4c98c5b4f3b04656cd19 Mon Sep 17 00:00:00 2001 From: Remy Marquis Date: Wed, 18 Mar 2020 17:47:36 +0100 Subject: [PATCH] Added index page --- README.md | 9 +++++++-- conf.py | 2 +- index.rst | 22 ++++++++++++++++++---- 3 files changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7f3982e..5cdd3b9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ -# etlegacy-docs -ET: Legacy documentation +# ET: Legacy documentation [![Documentation Status](https://readthedocs.org/projects/etlegacy/badge/?version=latest)](http://etlegacy.readthedocs.io/en/latest/?badge=latest) + +Reference documentation for ET: Legacy and the Legacy mod. The Lua API documentation is available [here](https://github.com/etlegacy/lua_apidoc). + +This documentation is generated with [Sphinx](http://www.sphinx-doc.org/) using the [reStructuredText](http://www.sphinx-doc.org/en/stable/rest.html) markup language. + +It can be read online at [etlegacy.rtfd.io](http://etlegacy.rtfd.io). diff --git a/conf.py b/conf.py index 2a38251..072bccb 100644 --- a/conf.py +++ b/conf.py @@ -17,7 +17,7 @@ # -- Project information ----------------------------------------------------- -project = 'ET: Legacy documentation' +project = 'ET: Legacy' copyright = '2012-2020, ET: Legacy Team' author = 'ET: Legacy Team' diff --git a/index.rst b/index.rst index 3d4dfce..c572345 100644 --- a/index.rst +++ b/index.rst @@ -3,13 +3,27 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to ET: Legacy documentation's documentation! -==================================================== +ET: Legacy +========== + +Welcome to the ET: Legacy's documentation! + +`ET: Legacy `_ is an open source project based on the code of `Wolfenstein: Enemy Territory `_ which `was released `_ in 2010 under the terms of the `GNU General Public License v3 `_. + +Set during World War II and heavily focused on team work, the game was initially released in 2003 by Splash Damage and id Software. More than a decade after its release, after spending countless hours of escorting tanks and trucks, stealing gold and radar parts and transmitting confidential documents, it was time to dust off the game which consistently refused to go down. + +Ambition +-------- + +There are two aspects to this project, an updated game version **ET: Legacy** and a new mod **Legacy**. + +* The main goal of **ET: Legacy** is to fix bugs and security exploits, remove old dependencies, add useful features and modernize its graphics while still remaining compatible with ET 2.60b and as many of its mods as possible. +* The main goal of **Legacy** is to stay close to the original gameplay experience and provide a updated but viable alternative to ETPro for competitive play while staying lightweight but extensible through additional Lua scripts. + +.. note:: This documentation aims to be a centralized reference only. For information about common issues, getting help or contributing to the project, ensure to visit our official `website `_ and `wiki `_. .. toctree:: :maxdepth: 2 - :caption: Contents: - Indices and tables