Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes and Contributing Section in README.md #36

Closed
wants to merge 1 commit into from
Closed

Changes and Contributing Section in README.md #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,51 @@

Important
---------
**This repository is moving to [Gitlab](https://gitlab.com/schnaader/fairytale) - please update your bookmarks and do any contributions there. The GitHub repository will be removed after successful migration.**
**This repository is moving to [Gitlab](https://gitlab.com/schnaader/fairytale) - please update your bookmarks and make any contributions there. The GitHub repository will be removed after successful migration.**

# Fairytale
modern lossless community archiver that features
This is a modern lossless community archiver that features:

* state of the art analysis of input data
* detection and transform / recompression of data to improve compression
* sorting input and arrange it in different streams
* deduplication across all streams and recursion levels
* applying different (best fit) compression algorithms on each stream
* storing compressed data in a modern archiver format
* State of the art analysis of input data
* Detection and transform / recompression of data to improve compression
* Sorting input and arrange it in different streams
* Deduplication across all streams and recursion levels
* Applying different (best fit) compression algorithms on each stream
* Storing compressed data in a modern archiver format

It offers great modularity so that any algorithm can be added to it
and enough flexibility to chose between fast, best practical or experimental state-of-the-art compression.
and enough flexibility to choose between fast, best practical, or experimental state-of-the-art compression.
Fairytale is a dream of a next generation archiver and it is a work in progress
so if you share our dream and want to contribute, [join our great community here](https://gitter.im/encode-ru-Community-Archiver)

How to build
------------

Using CMake (download it [here](https://cmake.org/download/)), you can build on many platforms using your favorite compiler (Visual Studio, MinGW, CodeBlocks, XCode, Unix Makefiles, ...). It will also detect automatically if zlib is installed and if not, compiles it from source.
Using CMake (download it [here](https://cmake.org/download/)), you can build on many platforms using your favorite compiler (Visual Studio, MinGW, CodeBlocks, XCode, Unix Makefiles, ...). It will also detect automatically if zlib is installed and if not, it compiles it from the source.

For Windows, there's a make.bat batch script that works with MinGW. Use `make` for a 64-bit build, `make 32` for a 32-bit build.

For Linux, OSX and ARM, there are Makefiles. Use `make` for a 64-bit build, `make -f Makefile.32` for a 32-bit build.
For Linux, OSX, and ARM, there are Makefiles. Use `make` for a 64-bit build, `make -f Makefile.32` for a 32-bit build.

Contributing
------------

1. Fork the repository
2. Clone the forked repository
3. Create your feature branch
```shell
git checkout -b branch-name
```
4. Make changes and commit them
```shell
git commit -am 'Example added'
```
5. Push commits to the branch
```shell
git push -u origin branch-name
```
7. Create a new Pull Request


Releases/Binaries
-----------------
Expand Down