Skip to content
Browse files

Add AUTHORS, LICENCE and README (sans installation instructions)

  • Loading branch information...
1 parent f29dc36 commit a9bb976c084fcc0ffe84b268e255fe60f9735cfc @robgolding63 committed Jan 28, 2011
Showing with 65 additions and 0 deletions.
  1. +6 −0 AUTHORS
  2. +15 −0 LICENCE
  3. +44 −0 README.md
View
6 AUTHORS
@@ -0,0 +1,6 @@
+Backtrac is the final-year university project of Rob Golding, developed whilst
+studying at the University of Nottingham, England.
+
+Primary Author:
+
+ * Rob Golding
View
15 LICENCE
@@ -0,0 +1,15 @@
+Backtrac Backup System is a version-centric backup solution for Linux.
+Copyright (C) 2011 Rob Golding
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
View
44 README.md
@@ -0,0 +1,44 @@
+Backtrac Backup System
+======================
+
+Backtrac is a version centric backup system for office and professional use.
+
+The web interface offers fast and effective access to all your files, with
+instant restoration of the unlimited version history for every file.
+
+All aspects of the system are written in pure Python, making use of the Django
+web development framework. The core networking functionality is implemented
+using the Twisted framework.
+
+Requirements
+============
+
+Both the client and server applications require Python version 2.6 or greater.
+Python 3.x is not supported at the present time.
+
+Client
+------
+
+The client is implemented in pure Python, based on the Twisted networking
+toolkit. This is the only 3rd party library that is required.
+
+* Twisted >= 10.2.0
+
+Server
+------
+
+The server daemon is also based on Twisted, and also makes use of the Django
+framework for database access (via the ORM). The web interface is also built
+entirely using Django.
+
+The application is being developed against Django trunk, with the expectation
+that version 1.3 will be released before Backtrac itself is finished. As such,
+the server is detailed as requiring Django version 1.3.
+
+* Twisted >= 10.2.0
+* Django == 1.3
+
+Installation
+============
+
+Coming soon.

0 comments on commit a9bb976

Please sign in to comment.
Something went wrong with that request. Please try again.