summaryrefslogtreecommitdiff
path: root/docs/dev/getting-started.md
diff options
context:
space:
mode:
authorClaudius2019-03-31 16:02:05 +0200
committerClaudius2019-04-01 01:03:36 +0200
commitedf301cfa320cce48eaf055a57f416bc1aa6ee1e (patch)
tree34e583fedcbce75bb3d4409cc5e21b3c18226b9f /docs/dev/getting-started.md
parent3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff)
splitting README.md into files in /docs for better readability
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to '')
-rw-r--r--docs/dev/getting-started.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md
new file mode 100644
index 00000000..6eb1b136
--- /dev/null
+++ b/docs/dev/getting-started.md
@@ -0,0 +1,16 @@
+# Developer Notes
+
+## Structure
+
+```text
+codimd/
+├── test/ --- test suite
+├── docs/ --- documentation
+├── lib/ --- server libraries
+└── public/ --- client files
+ ├── css/ --- css styles
+ ├── docs/ --- default documents
+ ├── js/ --- js scripts
+ ├── vendor/ --- vendor includes
+ └── views/ --- view templates
+```