Skip to content

Commit

Permalink
[DOCS] Updated documentation homepage to reflect commit fc387d9
Browse files Browse the repository at this point in the history
This commit updates the documentation homepage to reflect commit fc387d9. See the edits to line 16 (on the diff). It also includes general improvements to the homepage's wording.
  • Loading branch information
ZelnickB committed Sep 3, 2020
1 parent 63ae54d commit 42c63db
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Setup and General Knowledge

.. note:: In this documentation, ``/`` refers to the root directory of the Aluminum repository, except as otherwise noted.

To install Aluminum, simply clone the git repository, install the dependencies automatically with ``yarn``, and copy the default configuration files into the ``/prefs`` directory. Starting the web server is as simple as typing ``yarn run start`` into your terminal.
To install Aluminum, simply clone the git repository, install the dependencies automatically with ``yarn``, and copy the default user files from the ``/defaults`` directory to ``/usr``. Starting the server is as simple as typing ``yarn run start`` into your terminal.

.. seealso:: If you want to install Aluminum, please see the installation guide for more detailed instructions.
.. seealso:: Please see the installation guide for more detailed instructions on installing Aluminum.

Aluminum is controlled by configuration files written in JSON. These files are included in the ``/prefs`` directory.
Aluminum is controlled by JSON configuration files. These files are found in the ``/usr/prefs`` directory.


.. toctree::
Expand Down

0 comments on commit 42c63db

Please sign in to comment.