From 1a0737e4c94afdc5bcc7b5e851809955289bf667 Mon Sep 17 00:00:00 2001 From: Karol Stasiak Date: Wed, 28 Mar 2018 19:31:10 +0200 Subject: [PATCH] Rename documentation files --- README.md | 4 ++-- build.sbt | 2 +- {doc => docs}/abi/generated-labels.md | 0 {doc => docs}/abi/inlining.md | 0 {doc => docs}/abi/undefined-behaviour.md | 0 {doc => docs}/abi/undocumented.md | 0 {doc => docs}/abi/variable-storage.md | 0 {doc => docs}/api/command-line.md | 0 {doc => docs}/api/famicom-programming-guide.md | 0 {doc => docs}/api/getting-started.md | 0 {doc => docs}/api/target-platforms.md | 0 doc/README.md => docs/index.md | 0 {doc => docs}/lang/assembly.md | 0 {doc => docs}/lang/functions.md | 0 {doc => docs}/lang/interfacing.md | 0 {doc => docs}/lang/literals.md | 0 {doc => docs}/lang/operators.md | 0 {doc => docs}/lang/reentrancy.md | 0 {doc => docs}/lang/syntax.md | 0 {doc => docs}/lang/types.md | 0 examples/{README.md => index.md} | 0 21 files changed, 3 insertions(+), 3 deletions(-) rename {doc => docs}/abi/generated-labels.md (100%) rename {doc => docs}/abi/inlining.md (100%) rename {doc => docs}/abi/undefined-behaviour.md (100%) rename {doc => docs}/abi/undocumented.md (100%) rename {doc => docs}/abi/variable-storage.md (100%) rename {doc => docs}/api/command-line.md (100%) rename {doc => docs}/api/famicom-programming-guide.md (100%) rename {doc => docs}/api/getting-started.md (100%) rename {doc => docs}/api/target-platforms.md (100%) rename doc/README.md => docs/index.md (100%) rename {doc => docs}/lang/assembly.md (100%) rename {doc => docs}/lang/functions.md (100%) rename {doc => docs}/lang/interfacing.md (100%) rename {doc => docs}/lang/literals.md (100%) rename {doc => docs}/lang/operators.md (100%) rename {doc => docs}/lang/reentrancy.md (100%) rename {doc => docs}/lang/syntax.md (100%) rename {doc => docs}/lang/types.md (100%) rename examples/{README.md => index.md} (100%) diff --git a/README.md b/README.md index 1e4ddb7b..c9927a8a 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ For binary releases, see: https://github.com/KarolS/millfork/releases (latest: 0 ## More info -* [Documentation](doc/README.md) +* [Documentation](docs/index.md) -* [Example programs](examples/README.md) +* [Example programs](examples/index.md) ## Planned features diff --git a/build.sbt b/build.sbt index a69d5ef9..9f7abba0 100644 --- a/build.sbt +++ b/build.sbt @@ -59,7 +59,7 @@ releaseDist := { IO.copyDirectory(base / name, distDir / name) } copyDir("include") - copyDir("doc") + copyDir("docs") def entries(f: File): List[File] = f :: (if (f.isDirectory) IO.listFiles(f).toList.flatMap(entries) else Nil) IO.zip(entries(distDir).map(d => (d, d.getAbsolutePath.substring(distDir.getParent.length + 1))), zipFile) IO.delete(distDir) diff --git a/doc/abi/generated-labels.md b/docs/abi/generated-labels.md similarity index 100% rename from doc/abi/generated-labels.md rename to docs/abi/generated-labels.md diff --git a/doc/abi/inlining.md b/docs/abi/inlining.md similarity index 100% rename from doc/abi/inlining.md rename to docs/abi/inlining.md diff --git a/doc/abi/undefined-behaviour.md b/docs/abi/undefined-behaviour.md similarity index 100% rename from doc/abi/undefined-behaviour.md rename to docs/abi/undefined-behaviour.md diff --git a/doc/abi/undocumented.md b/docs/abi/undocumented.md similarity index 100% rename from doc/abi/undocumented.md rename to docs/abi/undocumented.md diff --git a/doc/abi/variable-storage.md b/docs/abi/variable-storage.md similarity index 100% rename from doc/abi/variable-storage.md rename to docs/abi/variable-storage.md diff --git a/doc/api/command-line.md b/docs/api/command-line.md similarity index 100% rename from doc/api/command-line.md rename to docs/api/command-line.md diff --git a/doc/api/famicom-programming-guide.md b/docs/api/famicom-programming-guide.md similarity index 100% rename from doc/api/famicom-programming-guide.md rename to docs/api/famicom-programming-guide.md diff --git a/doc/api/getting-started.md b/docs/api/getting-started.md similarity index 100% rename from doc/api/getting-started.md rename to docs/api/getting-started.md diff --git a/doc/api/target-platforms.md b/docs/api/target-platforms.md similarity index 100% rename from doc/api/target-platforms.md rename to docs/api/target-platforms.md diff --git a/doc/README.md b/docs/index.md similarity index 100% rename from doc/README.md rename to docs/index.md diff --git a/doc/lang/assembly.md b/docs/lang/assembly.md similarity index 100% rename from doc/lang/assembly.md rename to docs/lang/assembly.md diff --git a/doc/lang/functions.md b/docs/lang/functions.md similarity index 100% rename from doc/lang/functions.md rename to docs/lang/functions.md diff --git a/doc/lang/interfacing.md b/docs/lang/interfacing.md similarity index 100% rename from doc/lang/interfacing.md rename to docs/lang/interfacing.md diff --git a/doc/lang/literals.md b/docs/lang/literals.md similarity index 100% rename from doc/lang/literals.md rename to docs/lang/literals.md diff --git a/doc/lang/operators.md b/docs/lang/operators.md similarity index 100% rename from doc/lang/operators.md rename to docs/lang/operators.md diff --git a/doc/lang/reentrancy.md b/docs/lang/reentrancy.md similarity index 100% rename from doc/lang/reentrancy.md rename to docs/lang/reentrancy.md diff --git a/doc/lang/syntax.md b/docs/lang/syntax.md similarity index 100% rename from doc/lang/syntax.md rename to docs/lang/syntax.md diff --git a/doc/lang/types.md b/docs/lang/types.md similarity index 100% rename from doc/lang/types.md rename to docs/lang/types.md diff --git a/examples/README.md b/examples/index.md similarity index 100% rename from examples/README.md rename to examples/index.md