tweaking documentation · 5dd9b3bf3b - SVN.BY: Go Git Service
Browse Source

tweaking documentation

Tiernan O'Toole 7 years ago
parent
commit
5dd9b3bf3b
6 changed files with 7 additions and 48 deletions
  1. 0 41
      README.rst
  2. 0 1
      docs/history.rst
  3. 1 1
      docs/index.rst
  4. 2 2
      docs/installation.rst
  5. 0 1
      docs/readme.rst
  6. 4 2
      docs/usage.rst

+ 0 - 41
README.rst

@@ -1,41 +0,0 @@
1
-Template
2
-========
3
-
4
-$project will solve your problem of where to start with documentation,
5
-by providing a basic explanation of how to do it easily.
6
-
7
-Look how easy it is to use:
8
-
9
-    import project
10
-    # Get your stuff done
11
-    project.do_stuff()
12
-
13
-Features
14
---------
15
-
16
-- Be awesome
17
-- Make things faster
18
-
19
-Installation
20
-------------
21
-
22
-Install $project by running:
23
-
24
-    install project
25
-
26
-Contribute
27
-----------
28
-
29
-- Issue Tracker: github.com/$project/$project/issues
30
-- Source Code: github.com/$project/$project
31
-
32
-Support
33
--------
34
-
35
-If you are having issues, please let us know.
36
-We have a mailing list located at: project@google-groups.com
37
-
38
-License
39
--------
40
-
41
-The project is licensed under the BSD license.

+ 0 - 1
docs/history.rst

@@ -1 +0,0 @@
1
-.. include:: ../HISTORY.rst

+ 1 - 1
docs/index.rst

@@ -3,7 +3,7 @@
3 3
    You can adapt this file completely to your liking, but it should at least
4 4
    contain the root `toctree` directive.
5 5
 
6
-Welcome to Read the Docs Template's documentation!
6
+B2Uploader Documentation
7 7
 ==================================================
8 8
 
9 9
 Contents:

+ 2 - 2
docs/installation.rst

@@ -2,6 +2,6 @@
2 2
 Installation
3 3
 ============
4 4
 
5
-Install the package with pip::
5
+To install, download the lastest release from below and run
6 6
 
7
-    $ pip install read-the-docs-template
7
+    https://github.com/tiernano/b2uploader/releases

+ 0 - 1
docs/readme.rst

@@ -1 +0,0 @@
1
-.. include:: ../README.rst

+ 4 - 2
docs/usage.rst

@@ -2,6 +2,8 @@
2 2
 Usage
3 3
 ========
4 4
 
5
-To use this template, simply update it::
5
+Get the source and build in Visual Studio (2013 and 2015 should work). using cmd line, go to the build folder and run a command as follows:
6 6
 
7
-	import read-the-docs-template
7
+b2uploader --i accountid --a appkey --d directory_to_upload
8
+
9
+where accountid and appkey are gotten from BackBlaze's site, and the directory is the folder you want uploaded