System Requirements Specification

Suggestions and discussion of future versions
Post Reply
christosm
New User
New User
Posts: 4
Joined: Thu May 16, 2013 10:30 am

System Requirements Specification

Post by christosm »

Hi,
I am an undergraduate student and i would like to contribute by writing an SRS document for Deluge in english.
Am I free to start writing and are there any rules to follow ?
Cas
Top Bloke
Top Bloke
Posts: 3681
Joined: Mon Dec 07, 2009 6:04 am
Location: Scotland

Re: System Requirements Specification

Post by Cas »

You are welcome to contribute. You would want to read the current documentation and it is probably best to use the develop codebase for reference.

You can see all the wiki pages on TitleIndex but be aware that the occasional pages are for much older versions and are no longer valid.
christosm
New User
New User
Posts: 4
Joined: Thu May 16, 2013 10:30 am

Re: System Requirements Specification

Post by christosm »

I have uploaded the SRS document, here
https://dl.dropboxusercontent.com/u/186 ... %20SRS.pdf

give it a minute and let me know what you think.
thank you.
Cas
Top Bloke
Top Bloke
Posts: 3681
Joined: Mon Dec 07, 2009 6:04 am
Location: Scotland

Re: System Requirements Specification

Post by Cas »

Thank you for providing the document although I was not expecting that you would simply copy and paste the website introduction text. It would have been nice to see the information improved upon with additional detail. Also there are a few notable omissions:
  • Current developers contributing code to the project over the last ~6 months: https://github.com/cas--/Deluge/contrib ... -26&type=c
  • The GPL licence is specifically version 3.
  • Deluge can be used in a client/server setup so there is a daemon, deluged, and clients, deluge-gtk, deluge-console, deluge-web. More info: http://dev.deluge-torrent.org/wiki/UserGuide/ThinClient
  • There is no mention of the Plugins.
  • Developers would be interested in the APIs so you could mention that there is the DelugeRPC API and that deluge-web also provides a JSON-RPC API.
You have linked to a PDF, is there a raw text version that people can access?
christosm
New User
New User
Posts: 4
Joined: Thu May 16, 2013 10:30 am

Re: System Requirements Specification

Post by christosm »

Thank you for your feedback, its very much appreciated.

I will improve the document, include the omissions and provide a raw text version.
christosm
New User
New User
Posts: 4
Joined: Thu May 16, 2013 10:30 am

Re: System Requirements Specification

Post by christosm »

i tried to meet your conditions and extended the SRS to include the omissions.

The .odt file can be found here
http://db.tt/Eaywp7k0

a pdf
http://db.tt/ttScmfHA

and raw texts for Windows machines
http://db.tt/MNvluk8l
and for Linux ones
http://db.tt/Rn2fgpYe

if there are still problems i will be happy to fix them too.
Post Reply