From a11e8c0161fc5c73d6d89cb866e59a00095cb2bf Mon Sep 17 00:00:00 2001 From: Karissa McKelvey Date: Wed, 30 Dec 2015 16:52:59 -0500 Subject: add docs --- extra.css | 19 +++++++++++++++++++ meta/changelog.md | 5 +++++ meta/collaborators.md | 8 ++++++++ technical.md | 19 +++++++++++++++++++ 4 files changed, 51 insertions(+) create mode 100644 extra.css create mode 100644 meta/changelog.md create mode 100644 meta/collaborators.md create mode 100644 technical.md diff --git a/extra.css b/extra.css new file mode 100644 index 0000000..b1f46c2 --- /dev/null +++ b/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/meta/changelog.md b/meta/changelog.md new file mode 100644 index 0000000..bbdd4b1 --- /dev/null +++ b/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/meta/collaborators.md b/meta/collaborators.md new file mode 100644 index 0000000..dffc9bb --- /dev/null +++ b/meta/collaborators.md @@ -0,0 +1,8 @@ +## Collaborators + +dat is only possible due to the excellent work of the following collaborators: + + + + +
maxogdenGitHub/maxogden
mafintoshGitHub/mafintosh
karissaGitHub/karissa
diff --git a/technical.md b/technical.md new file mode 100644 index 0000000..3c68953 --- /dev/null +++ b/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`. -- cgit v1.2.3