Skip to content

Commit

Permalink
Added some more basic documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
CreepPork committed Mar 2, 2019
1 parent 7f00777 commit 8e8cd94
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 14 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
docs/build
docs/build
docs/source/_build
.vscode/
2 changes: 2 additions & 0 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Frequently Asked Questions
==========================
2 changes: 2 additions & 0 deletions docs/source/features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Achilles Features
=================
54 changes: 41 additions & 13 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,48 @@
.. Achilles documentation master file, created by
sphinx-quickstart on Sat Mar 2 20:07:32 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Achilles: Zeus on Steroids
==========================

Welcome to Achilles's documentation!
====================================
.. warning::
The current documentation is still a work-in-progress and does not reflect the current release version of Achilles.

`Achilles <https://github.com/ArmaAchilles/Achilles>`_ is a gameplay modification for Arma 3. It expands the Zeus real-time editor with many new additions as well as provides bug fixes.

Achilles started as an expansion to `Ares <https://github.com/astruyk/Ares>`_ mod, which was created by `Anton Struyk <https://github.com/astruyk>`_. Achilles became the *de facto* successor to Ares at the point the latter was no longer updated. Achilles has already grown into a *splendid* project, but new additions are still to come!

Tons of new modules
Achilles provides new and exciting modules to spice up your gameplay and provide new experiences for all players.

Lots of customizability
Using the powerful CBA settings framework, we provide stunning amounts of customizability for the Zeus interface to tailor it to just you.

Tried and tested
As Achilles grew from Ares in 2016, it has accumulated over 250 000 unique downloads and come to a more and more polished product that has recieved many transformations over the years to make it even more splendid.

Open source
Achilles is open source and has been so from the earliest of days. We are actively supporting the introduction of new contributions.

First steps
-----------

Are you looking to create a new world of experiences for your multiplayer missions or just looking to have fun? Learn how to install Achilles and get playing with the revamped Zeus.

- **Getting started**:
:doc:`Installing Achilles <intro/installing-achilles>` |
:doc:`Preparing a mission with Achilles <intro/mission-setup>`

.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 2
:hidden:
:caption: First Steps

intro/installing-achilles
intro/mission-setup

.. _user-docs:

Indices and tables
==================
.. toctree::
:maxdepth: 2
:caption: User Documentation

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
features
support
faq
2 changes: 2 additions & 0 deletions docs/source/intro/installing-achilles.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Installing Achilles
===================
2 changes: 2 additions & 0 deletions docs/source/intro/mission-setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Mission Setup
=============
2 changes: 2 additions & 0 deletions docs/source/support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Support
=======

0 comments on commit 8e8cd94

Please sign in to comment.