Skip to content

Commit

Permalink
docs: include existing *.md files. Move projucer info to docs dir
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher31 committed Jul 15, 2021
1 parent 5eda8c1 commit 31883ee
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 19 deletions.
9 changes: 9 additions & 0 deletions docs/building-projucer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Element Projucer Projects
These projects are provided as a convenience to Mac/PC __developers__ who want to __contribute__ to the project, but aren't comfortable with `waf`. Linux exporters don't exists in these projects. If you're on Linux, please use waf. _See [building.md](building.md)_

If you're compiling for just __personal__ use of the software and nothing else... advice from developers is bare minimum.

__Directories__
* `tools/jucer/Element` - Element plugin (instrument variety)
* `tools/jucer/ElementFX` - Element plugin (effect variety)
* `tools/jucer/Standalone` - Element standalone
2 changes: 1 addition & 1 deletion docs/building.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Building Element with Waf
The instructions below are for *nix based system such as Ubuntu. Usage of `sudo` is optional depending on your system. There are also [projucer projects](../tools/jucer), if you prefer.
The instructions below are for *nix based system such as Ubuntu. Usage of `sudo` is optional depending on your system. There are also [projucer projects](building-projucer.md), if you prefer.

__Sub Modules__
This project uses submodules. Be sure to do this on a fresh clone, or when pulling changes.
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import sphinx_rtd_theme

# -- Project information -----------------------------------------------------

Expand All @@ -31,6 +32,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'myst_parser',
'sphinx_rtd_theme'
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -47,7 +50,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
30 changes: 24 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,36 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Element's documentation!
===================================
Element
=======
Welcome to the Element user/developer manual.

.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 1
:caption: Application

Keyboard Commands <key-commands>
OSC <osc>

.. toctree::
:maxdepth: 1
:caption: Scripting

Element Lua API <https://api.kushview.net/lua/el/latest>
KV Lua Modules API <https://api.kushview.net/lua/kv/latest>

.. toctree::
:maxdepth: 1
:caption: Developers

Building <building>
Projucer <building-projucer>
C++ Code Style <code-style>
Lua Code Style <lua-style>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Welcome to the DOCS
11 changes: 0 additions & 11 deletions tools/jucer/README.md

This file was deleted.

0 comments on commit 31883ee

Please sign in to comment.