github wiki setup

GitHub Wiki notes

This wiki is a sibling git repository to zFlux/soundwave: clone URL git@github.com:zFlux/soundwave.wiki.git (or https://github.com/zFlux/soundwave.wiki.git).

Relationship to the application repository

Documentation lives here, not in the main Soundwave repo. The application repository holds code and assets; conceptual docs, design notes, and setup instructions are maintained as wiki pages (backed by this git repo).

Workflow:

• Edit wiki pages in the GitHub Wiki UI, or clone this repository, edit .md files locally, commit, and push.
• Changes to the wiki do not require a commit to the main soundwave repo unless you are also changing application code.

Clone this wiki locally

git clone https://github.com/zFlux/soundwave.wiki.git
cd soundwave.wiki
# edit .md files, then:
git add .
git commit -m "Update wiki"
git push

The default landing page is Home.md. Optional navigation: _Sidebar.md.