update README after the project archival
This commit is contained in:
parent
894ae1f30e
commit
d6d0a22ece
GPG Key ID:
BFBAF4C975F76450
@ -1,90 +0,0 @@
|
||||
=========================
|
||||
Contributing to magnetico
|
||||
=========================
|
||||
|
||||
Hello there! We would be glad to accept your contributions and this is document is a guide to help you throughout the
|
||||
process of contributing.
|
||||
|
||||
Kinds of Contributions
|
||||
======================
|
||||
There are several kinds of contributions and feel free to choose ones that you feel most comfortable with:
|
||||
|
||||
1. Programming
|
||||
|
||||
If you are a **Go** programmer, great! **JavaScript** programmers are too welcome. **magneticod** and
|
||||
**magneticow** are programmed in Go, and we use a tiny tiny bit of JavaScript for the web interface offered by
|
||||
**magneticow**. We are trying to keep the amount of JavaScript used to the bare minimum (so that users with NoScript
|
||||
and JavaScript disabled can still use it), so if your contribution is refused, please do not take it personally.
|
||||
|
||||
2. Testing
|
||||
|
||||
**magnetico** is still a pre-v1.0 software, hence is considered unstable. Currently, developers are testing
|
||||
**magnetico** themselves before each version and this is a very tiresome task. Also, due to lack of resources and
|
||||
diversity of different setups we have, we cannot test **magnetico** extensively. If you would like to test
|
||||
**magnetico** for us, we would be grateful.
|
||||
|
||||
3. User Interface Design & User Experience
|
||||
|
||||
**magnetico** is not the first DHT search engine, but "the first autonomous (self-hosted) BitTorrent DHT search
|
||||
engine suite that is designed **for end-users**." We care about *end-users* and value their experience while using
|
||||
**magnetico** suite. Ease of installation, and of use are our primary concerns and any contributions to improve these
|
||||
experiences are much welcome.
|
||||
|
||||
Things Every Contributor Should Know
|
||||
====================================
|
||||
* Join `magnetico-dev gitter channel <https://gitter.im/magnetico-dev/magnetico-dev>`_ to join the conversation. We
|
||||
value every opinion.
|
||||
* Let people know what you are planning to do, especially before undertaking a huge task. It is very discouraging to
|
||||
spend your time on a daunting task and to see it refused. Asking people before acting would prevent such situations
|
||||
and easier for both parties to be prepared.
|
||||
* Do not argue against the first principles of the project. The **magnetico** project is not just a piracy tool or
|
||||
whatever you think it to be, but it is a **self-hosted** DHT search engine, to serve as another core component of the
|
||||
BitTorrent network, to resist censorship and protect users' privacy. Any attempt to violate these principles in favour
|
||||
of anything else (which you might think to be more *practical*) will be firmly refused.
|
||||
|
||||
Python Coding Guidelines
|
||||
========================
|
||||
.. image:: https://api.travis-ci.org/boramalper/magnetico.svg?branch=master
|
||||
:target: https://travis-ci.org/boramalper/magnetico
|
||||
|
||||
* In general, we follow `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ and
|
||||
`Google Python Style Guide <https://google.github.io/styleguide/pyguide.html>`_.
|
||||
* Prefer this document over Google Python Style Guide over PEP 8 in case of conflict.
|
||||
|
||||
|
||||
|
||||
* Maximum line length is 120 characters.
|
||||
* Do not abbreviate variable names, unless the abbreviation is famous (even though it might be *obvious* in its code
|
||||
context). For instance, `HTTP` is accepted, but `_f` for *futures* and `p_` for *parent* are NOT.
|
||||
|
||||
* A possible exception of this rule is to use shorter names in case of complex symbolic manipulation and/or
|
||||
operations, for instance in complex for-loops, functions etc. Shorter names would allow the programmer to follow the
|
||||
flow of the operations and logic behind the manipulation more easily and hence justified. But, comments are required
|
||||
in those cases.
|
||||
* Do NOT use shebang line to specify the interpreter or the encoding of the file. Go is compiled, and the native encoding is UTF-8, for every and each source file.
|
||||
* Prefer Go standard library over 3rd party solutions, unless justified.
|
||||
|
||||
|
||||
|
||||
* We use `Travis CI <https://travis-ci.org/boramalper/magnetico>`_ to automatically run tests on the latest code. We use
|
||||
|
||||
* `pylint <https://www.pylint.org/>`_
|
||||
* `mypy <http://mypy-lang.org/>`_
|
||||
|
||||
for overall code quality and static type checking. Both are very powerful tools and we depend on them a lot to prevent
|
||||
unforeseen bugs at "compile" time. Please make sure that your changes do NOT introduce new warnings. Fixing the old
|
||||
code that caused warnings are also much welcome.
|
||||
* **Type-annotate all function signatures (all arguments and return values).**
|
||||
|
||||
Testing and User Interface Design & User Experience
|
||||
===================================================
|
||||
As we lack both experience and contributors, we cannot even write contributions guidelines. =)
|
||||
|
||||
Just shoot us a message if you are interested in and let's discuss.
|
||||
|
||||
----
|
||||
|
||||
**P.S.** If you feel overwhelmed after seeing this document, don't. Send your first contributions and I'll personally
|
||||
help you through your first contribution. =)
|
||||
|
||||
Bora, <bora@boramalper.org>
|
||||
56
README.md
56
README.md
@ -1,16 +1,13 @@
|
||||
> # Archival Notice
|
||||
> # Maintenance Notice
|
||||
>
|
||||
> Hello! 👋 I've been working on **magnetico** since 2017 (less so in the recent years) and seeing so many people interested in it and using it has been a great source of joy and pride for me. However, I have decided that it is for the best to acknowledge and admit openly that I no longer have as much time as I did in high school, nor any willingness to spend the little time I now have by working on **magnetico** or any other [free software](https://en.wikipedia.org/wiki/Free_software) in general, except what I think is [the most important problem in the world](http://www.aaronsw.com/weblog/productivity#:~:text=not%20working%20on-,the%20most%20important%20problem%20in%20the%20world,-\)%20but%20each%20little) that I can work on at that moment.
|
||||
>
|
||||
> Fork it, improve it, ship it; keep up the good fight against scarcity. ☀️
|
||||
>
|
||||
> Bora <bora at [boramalper.org](https://boramalper.org/)>
|
||||
> I (rnhmjoj) took over **magnetico** maintenance after the original author
|
||||
> (boramalper) stopped working on it. You can consider the project in long
|
||||
> maintenance mode: I will try to keep it up-to-date and working as best as I
|
||||
> can, but don't expect any new features.
|
||||
|
||||
# magnetico
|
||||
*Autonomous (self-hosted) BitTorrent DHT search engine suite.*
|
||||
|
||||
[](https://gitter.im/magnetico-dev/magnetico-dev) [](https://github.com/boramalper/magnetico/actions) [](https://bestpractices.coreinfrastructure.org/projects/1029)
|
||||
|
||||
magnetico is the first autonomous (self-hosted) BitTorrent DHT search engine suite that is *designed
|
||||
for end-users*. The suite consists of two packages:
|
||||
|
||||
@ -26,7 +23,7 @@ central entity*.
|
||||
|
||||
## Features
|
||||
- Easy installation & minimal requirements:
|
||||
- [Pre-compiled static binaries](https://github.com/boramalper/magnetico/releases)
|
||||
- [Pre-compiled static binaries](https://maxwell.ydns.eu/git/rnhmjoj/magnetico/releases)
|
||||
- Root access is *not* required to install or to use.
|
||||
- Near-zero configuration:
|
||||
- Both programs work out of the box, and **magneticow** can be used without a web-server too.
|
||||
@ -61,19 +58,22 @@ trackers, allowing peers to discover each other through other peers and to fetch
|
||||
leechers & seeders in the network. **magnetico** is the finishing move that allows users to search
|
||||
for torrents in the network, hence removing the need for centralised torrent websites.
|
||||
|
||||
## Installation Instructions
|
||||
> **WARNING:**
|
||||
>
|
||||
> **magnetico** is still under active construction, and is considered *alpha* software. Please
|
||||
> use **magnetico** suite with care and follow the installation instructions carefully to install
|
||||
> it & secure the installation. Feel perfectly free to send bug reports, suggestions, or whatever
|
||||
> comes to your mind to send to us through GitHub or personal e-mail.
|
||||
## Build Instructions
|
||||
|
||||
> **WARNING:**
|
||||
>
|
||||
> Do NOT clone the [repository](https://github.com/boramalper/magnetico) to install **magnetico**,
|
||||
> as it is never meant to be stable (except
|
||||
> [releases](https://github.com/boramalper/magnetico/releases) of course).
|
||||
To build from source, if you have Nix, simply do `nix-build` in the project directory.
|
||||
|
||||
Otherwise, make sure you have:
|
||||
|
||||
1. the standard Go toolchain
|
||||
2. a C compiler
|
||||
3. the sqlite library
|
||||
|
||||
and then do
|
||||
|
||||
go install -tags='fts5,libsqlite3' -ldflags='-s -w' ./cmd/magneticod
|
||||
go install -tags='fts5,libsqlite3' -ldflags='-s -w' ./cmd/magneticow
|
||||
|
||||
## Installation Instructions
|
||||
|
||||
1. Install **magneticod** first by following its [installation instructions](cmd/magneticod/README.md).
|
||||
2. Install **magneticow** afterwards by following its
|
||||
@ -84,20 +84,6 @@ for torrents in the network, hence removing the need for centralised torrent web
|
||||
All the code is licensed under AGPLv3, unless stated otherwise specifically. See `COPYING` for
|
||||
details.
|
||||
|
||||
## Donations
|
||||
### Patreon
|
||||
https://www.patreon.com/boramalper
|
||||
|
||||
### PayPal
|
||||
https://paypal.me/boramalper
|
||||
|
||||
### Cryptocurrencies (Coinbase)
|
||||
- **BTC:** `3BLWjamWug3QQzcDDGwYLwuCqJyjcfYJB8`
|
||||
- **LTC:** `MRWX5SGCF7EvN15gpzT5b3KQD3Z91gH8qi`
|
||||
- **BCH:** `qqn07a58hax9l8pckq9j8ys6dsh2cnu4rsyztw2kj9`
|
||||
- **ETH:** `0xe5A8e80bAA6129DF7eBB1B5302F9e2Ef4C6f6E62`
|
||||
- **ETC:** `0x8964EcC86eaf043Bff2CdfE875E73D8095c26a58`
|
||||
|
||||
----
|
||||
|
||||
Dedicated to Cemile Binay, in whose hands I thrived.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user