Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Kill .bzr stuff, add .gitignore & a pretty README.md for GitHub.

  • Loading branch information...
commit 92ac787315f2c157372009b30006d7fedda6cbc3 1 parent cf72abe
@inpheaux inpheaux authored
Showing with 81 additions and 38 deletions.
  1. +0 −15 .bzreol
  2. +0 −10 .bzrignore
  3. +0 −13 .bzrtab
  4. +27 −0 .gitignore
  5. +54 −0 README.md
View
15 .bzreol
@@ -1,15 +0,0 @@
-[LF]
-.bzreol
-.bzrignore
-*.py
-*.tmpl
-*.js
-*.css
-*.txt
-*.po
-*.pot
-*.sh
-[CRLF]
-*.bat
-*.cmd
-*.nsi
View
10 .bzrignore
@@ -1,10 +0,0 @@
-*.pyc
-*.pyo
-build
-dist
-locale
-srcdist
-cherrypy
-*.wpr
-*.keep
-*.bak
View
13 .bzrtab
@@ -1,13 +0,0 @@
-[NOTAB]
-*.py
-*.txt
-*.po
-*.pot
-*.sh
-*.bat
-*.cmd
-*.nsi
-*.tmpl
-*.js
-*.css
-[TAB]
View
27 .gitignore
@@ -0,0 +1,27 @@
+#Compiled python
+*.py[co]
+
+# Working folders for Win build
+build/
+dist/
+locale/
+srcdist/
+
+# Generated email templates
+email/
+
+# Romanian ro.po is generated from ro.px, due to mapping to latin-1
+po/*/ro.po
+
+# Build results
+SABnzbd*.zip
+SABnzbd*.exe
+SABnzbd*.gz
+
+# WingIDE project file
+*.wpr
+
+# General junk
+*.keep
+*.bak
+*.log
View
54 README.md
@@ -0,0 +1,54 @@
+SABnzbd - The automated Usenet download tool
+============================================
+
+SABnzbd is an Open Source Binary Newsreader written in Python.
+
+It's totally free, incredibly easy to use, and works practically everywhere.
+
+SABnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.
+
+If you want to know more you can head over to our website: http://sabnzbd.org.
+
+## Resolving Dependencies
+
+SABnzbd has a good deal of dependencies you'll need before you can get running. If you've previously run SABnzbd from one of the various Linux packages floating around (Ubuntu, Debian, Fedora, etc), then you likely already have all the needed dependencies. If not, here's what you're looking for:
+
+- `python` (We support Python 2.5-2.7, preferably 2.6 or 2.7.)
+- `python-cheetah`
+- `python-configobj`
+- `python-feedparser`
+- `python-dbus`
+- `python-openssl`
+- `python-support`
+- `python-yenc`
+- `par2` (Multi-threaded par2 can be downloaded from [ChuChuSoft](http://chuchusoft.com/par2_tbb/download.html) )
+- `unrar` (Make sure you get the "official" non-free version of unrar)
+- `unzip`
+
+Your package manager should supply these. If not, we've got links in our more in-depth [installation guide](https://github.com/sabnzbd/sabnzbd/blob/master/INSTALL.txt).
+
+## Running SABnzbd from source
+
+Once you've sorted out all the dependencies, simply run:
+
+```
+python SABnzbd.py
+```
+
+Or, if you want to run in the background:
+
+```
+python -d -f /path/to/sabnzbd.ini
+```
+
+If you want multi-language support, run:
+
+```
+python tools/make_mo.py
+```
+
+Our many other commandline options are explained in depth [here](http://wiki.sabnzbd.org/command-line-parameters).
+
+## About Our Repo
+
+We're going to be attempting to follow the [gitflow model](http://nvie.com/posts/a-successful-git-branching-model/), so you can consider "master" to be whatever our present stable release build is (presently 0.6.x) and "develop" to be whatever our next build will be (presently 0.7.x). Once we transition from unstable to stable dev builds we'll create release branches, and encourage you to follow along and help us test.
Please sign in to comment.
Something went wrong with that request. Please try again.