aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/extra.css19
l---------docs/index.md1
-rw-r--r--docs/meta/changelog.md5
-rw-r--r--docs/meta/collaborators.md8
-rw-r--r--docs/technical.md19
5 files changed, 52 insertions, 0 deletions
diff --git a/docs/extra.css b/docs/extra.css
new file mode 100644
index 0000000..b1f46c2
--- /dev/null
+++ b/docs/extra.css
@@ -0,0 +1,19 @@
+.wy-side-nav-search {
+ background-color: #35b44f;
+}
+
+body {
+ font-size: 1em;
+}
+
+code, .hljs-tag, .hljs-built_in, .hljs-tag .hljs-title, .hljs-rule .hljs-property, .django .hljs-tag, .hljs-keyword, .css .rule .hljs-keyword, .hljs-winutils, .nginx .hljs-title, .hljs-subst, .hljs-request, .hljs-status, .hljs-comment, .diff .hljs-header, .hljs-javadoc {
+ font-weight: normal;
+ font-style: normal;
+ color: #111;
+ font-size: 16px;
+}
+
+h3, h4, h5, h6 {
+ color: #6A7380;
+ margin-top: 1em;
+}
diff --git a/docs/index.md b/docs/index.md
new file mode 120000
index 0000000..42061c0
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1 @@
+README.md \ No newline at end of file
diff --git a/docs/meta/changelog.md b/docs/meta/changelog.md
new file mode 100644
index 0000000..bbdd4b1
--- /dev/null
+++ b/docs/meta/changelog.md
@@ -0,0 +1,5 @@
+## Changelog
+
+### 7.1.1 and earlier
+
+These refer to the pre-1.0 versions of dat and are omitted.
diff --git a/docs/meta/collaborators.md b/docs/meta/collaborators.md
new file mode 100644
index 0000000..dffc9bb
--- /dev/null
+++ b/docs/meta/collaborators.md
@@ -0,0 +1,8 @@
+## Collaborators
+
+dat is only possible due to the excellent work of the following collaborators:
+
+<table><tbody><tr><th align="left">maxogden</th><td><a href="https://github.com/maxogden">GitHub/maxogden</a></td></tr>
+<tr><th align="left">mafintosh</th><td><a href="https://github.com/mafintosh">GitHub/mafintosh</a></td></tr>
+<tr><th align="left">karissa</th><td><a href="https://github.com/karissa">GitHub/karissa</a></td></tr>
+</tbody></table>
diff --git a/docs/technical.md b/docs/technical.md
new file mode 100644
index 0000000..3c68953
--- /dev/null
+++ b/docs/technical.md
@@ -0,0 +1,19 @@
+## Hidden folder
+
+Dat stores its data in a hidden folder that is stored by default in the user's home directory.
+
+```
+~/.dat
+```
+
+Because of this, data is only ever downloaded once. That is, if you have multiple projects that use the same data (perhaps at different versions) on the same machine, dat will first check the global `.dat` folder to see if the data has already been downloaded before querying the network.
+
+The global `.dat` folder has:
+
+```
+$ ls ~/.dat
+db
+config
+```
+
+`dat` will first check `/root/.dat` and then `~/.dat`. So, if you want to have the .dat available globally, move the folder to `/root/.dat`.