transmission/docs/README.md

45 lines
2.5 KiB
Markdown
Raw Normal View History

# 1. General help #
2022-02-21 16:39:27 +00:00
New to Transmission?
* Try the help in Transmission's "Help" menu.
* simplehelp.net has an introduction for [Transmission on Macs](https://www.simplehelp.net/2008/07/17/how-to-use-transmission-as-your-bittorrent-client-os-x/).
* Jun Azua has an introduction for [Transmission GUI on Linux](https://www.junauza.com/2009/01/how-to-use-bittorrent-in-linux.html).
* Running Transmission [without a GUI](HeadlessUsage)
* Using Transmission [from a web browser](Web Interface)
2022-02-21 16:39:27 +00:00
Want to learn more?
* Visit our [forums](https://forum.transmissionbt.com)
* Visit our [IRC](https://en.wikipedia.org/wiki/IRC) channel: [#transmission on Libera.Chat](https://irc.libera.chat/transmission)
* Follow us on [Twitter](https://twitter.com/transmissionbt)
2022-02-21 16:39:27 +00:00
Want to contribute?
Much of this documentation is out-of-date or could be improved. Pull requests are greatly appreciated!
# 2. More documentation #
* [Configuration files](./Configuration-Files.md)
* [Editing configuration files](./Editing-Configuration-Files.md)
* [Environment variables](Environment-Variables.md)
* [Extending Transmission using scripts](./Scripts.md)
* [Blocklists](./Blocklists.md)
* [How to build Transmission](Building-Transmission.md)
* [RPC protocol specification](rpc-spec.md)
* [Transmisson's Peer ID and User-Agent headers](Peer-ID-and-User-Agent.md)
* [Peer status text explained](Peer-Status-Text.md)
2022-02-21 16:39:27 +00:00
# 3. Report a problem / request a feature #
* [Check](https://github.com/transmission/transmission/issues) whether the problem has already been reported.
* If you do not see a ticket matching your problem or feature, read [this post](https://forum.transmissionbt.com/viewtopic.php?f=1&t=3274) about what to write, then [add a new ticket](https://github.com/transmission/transmission/issues/new).
* If you _do_ see an existing ticket, please add a comment there. The more users are interested in a ticket, the higher its priority.
2022-02-21 16:39:27 +00:00
# 4. For contributors #
2022-02-21 16:39:27 +00:00
Transmission is a volunteer project and welcomes help.
Please contact us if you are interested in supporting Transmission in any of the following ways:
* Code contribution
* Testing
* [Language translations](Translating)
2022-02-21 16:39:27 +00:00
* Bug and request management
* Documentation and Wiki editing
2022-02-21 16:39:27 +00:00
* [Donations](https://transmissionbt.com/donate/)
* If you want to alert us of a security vulnerability, please email security@transmissionbt.com. Please note that general support questions belong on the forum, and will be ignored if sent to this email address.