summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames O'Shannessy <james.oshannessy@fiberdyne.com.au>2018-10-08 15:19:34 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:45 +1100
commit056c3754bc7be349de1a41ac6d4819f3d032bd0c (patch)
tree558603c87a397f72726437ad95b10037ebd648d3
parent13610114b7f283718a678c42e0421c3c51de636e (diff)
Fixing table of contents in README documentation
Restructure docs file tree Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
-rw-r--r--README.md5
-rw-r--r--docs/1.Introduction.md (renamed from docs/1. Introduction.md)0
-rw-r--r--docs/2.Building.md (renamed from docs/2. Building.md)1
-rw-r--r--docs/3.Usage.md (renamed from docs/3. Usage.md)0
-rw-r--r--docs/4.4A-Integration.md (renamed from docs/4. 4A Integration)0
5 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index fe4a883..f19e7d5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
## Alsa Virtual Sound Driver
-[1. Introduction](docs/1. Introduction.md)
+[1. Introduction](docs/1.Introduction.md)
+[2. Building](docs/2.Building.md)
+[3. Usage](docs/3.Usage.md)
+[4. 4A Integration](docs/4.4A-Integration.md)
## TODO
diff --git a/docs/1. Introduction.md b/docs/1.Introduction.md
index 29cac71..29cac71 100644
--- a/docs/1. Introduction.md
+++ b/docs/1.Introduction.md
diff --git a/docs/2. Building.md b/docs/2.Building.md
index 0016822..237d834 100644
--- a/docs/2. Building.md
+++ b/docs/2.Building.md
@@ -43,6 +43,7 @@ $ ./make_agl.sh ${XDS_SDK_ID}
The kernal modules can be built in tree, dependent on the avirt repository being located in drivers/staging - If using your own fork of the linux kernel, you will need to update the staging Makefiles and Kconfigs accordingly.
To build in tree, use the [Fiberdyne Linux fork](https://github.com/fiberdyne/linux), which will automatically clone the AVIRT Driver and required AudioPath modules to the `drivers/staging` directory. You can then turn AVIRT Support on by setting to `<M>`. The drivers can be found here:
+
```
$ make menuconfig
diff --git a/docs/3. Usage.md b/docs/3.Usage.md
index 7eb46d3..7eb46d3 100644
--- a/docs/3. Usage.md
+++ b/docs/3.Usage.md
diff --git a/docs/4. 4A Integration b/docs/4.4A-Integration.md
index 7c9b980..7c9b980 100644
--- a/docs/4. 4A Integration
+++ b/docs/4.4A-Integration.md