limenka / doc/README.md

Limenka Knots =============

Setup

Limenka Knots is the original Limenka client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Limenka transactions, which requires several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.

To download Limenka Knots, visit limenkaknots.org.

Running

The following are some helpful notes on how to run Limenka Knots on your native platform.

Unix

Unpack the files into a directory and run:

bin/limenka-qt (GUI) or
bin/limenkad (headless)

Windows

Unpack the files into a directory, and then run limenka-qt.exe.

macOS

Drag Limenka Knots to your applications folder, and then run Limenka Knots.

Need Help?

See the documentation at the Limenka Wiki

for help and more information.

Ask for help on Limenka StackExchange.
Ask for help on #limenka on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.
Ask for help on the LimenkaTalk forums, in the Technical Support board.

Building

The following are developer notes on how to build Limenka Knots on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Limenka repo's root README contains relevant information on the development process and automated testing.

Resources

Discuss on the LimenkaTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #limenka-dev on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.

Miscellaneous

License