Organize docs. ()

This commit is contained in:
Antonio Navarro Perez 2021-10-08 11:52:37 +02:00 committed by GitHub
parent 891afabb6d
commit 0a96f836b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 145 additions and 110 deletions

View file

@ -29,38 +29,37 @@
![Distribyted Screen Shot][product-screenshot]
Distribyted tries to make easier integrations with other applications among torrent files, presenting them as a standard filesystem.
Distribyted is an alternative torrent client.
It can expose torrent files as a standard FUSE mount or webDAV endpoint and download them on demand, allowing random reads using a fixed amount of disk space.
We aim to use some compressed file characteristics to avoid download it entirely, just the parts that we'll need.
Also, if the file format is not supported, distribyted can stream and seek through the file if needed.
Distribyted tries to make easier integrations with other applications using torrent files, presenting them as a standard filesystem.
**Note that distribyted is in alpha version, it is a proof of concept with a lot of bugs.**
### Use Cases
## Use Cases
- Play **multimedia files** on your favorite video or audio player. These files will be downloaded on demand and only the needed parts.
- Explore TBs of data from public **datasets** only downloading the parts you need. Use **Jupyter Notebooks** directly to process or analyze this data.
- Play your **ROM backups** directly from the torrent file. You can have virtually GBs in games and only downloaded the needed ones.
### Supported _Expandable_ File Formats
Distribyted can show some kind of files directly as folders, making it possible for applications read only the parts that they need. Here is a list of supported, to be supported and not supported formats.
#### Supported
- zip: Able to uncompress just one file. The file is decompressed to a temporal file sequentially to make possible seek over it. The decompression stops if no one is reading it.
#### To Be Supported
- tar: Seek to any file and inside that files using a [modified standard library](https://github.com/ajnavarro/go-tar). Not useful on `.tar.gz` files.
- 7zip: Similar to Zip. Need for a library similar to [zip](https://github.com/saracen/go7z).
- xz: Only worth it when the file is created using blocks. Possible library [here](https://github.com/ulikunitz/xz) and [here](https://github.com/frrad/bxzf).
#### Not Supported
- gzip: As far as I know, it doesn't support random access.
## Documentation
Check [here][main-url] or [here][doc-folder-url] for further documentation.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GPL3 license. See `LICENSE` for more information.
[doc-folder-url]: https://github.com/distribyted/distribyted/blob/master/mkdocs/docs/index.md
[main-url]: https://distribyted.com
[releases-shield]: https://img.shields.io/github/v/release/distribyted/distribyted.svg?style=flat-square