Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
markozagar committed Mar 21, 2020
1 parent 22d80d6 commit bf2a8aa
Showing 1 changed file with 39 additions and 8 deletions.
47 changes: 39 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,37 @@
# Ixian-LiteWallet
# Ixian Project - LiteWallet
Simple command line interface (CLI) wallet for the Ixian cryptocurrency.

## Development branches
## About Ixian

There are two main development branches:
* master: This branch is used to build the binaries for the official IXIAN DLT network. It should change slowly and be quite well-tested. This is also the default branch for anyone who wishes to build their Ixian software from source.
* development: This is the main development branch and the source for testnet binaries. The branch might not always be kept bug-free, if an extensive new feature is being worked on. If you are simply looking to build a current testnet binary yourself, please use one of the release tags which will be associated with the master branch.
Ixian DLT is a revolutionary blockchain that brings several innovative advantages, such as processing a high volume of micro-transactions quickly while consuming a low amount of processing power, disk space and energy.

**Homepage**: https://www.ixian.io

**Discord**: https://discord.gg/pdJNVhv

**Bitcointalk**: https://bitcointalk.org/index.php?topic=4631942.0

**Documentation**: https://docs.ixian.io

## The repository

The Ixian GitHub project is divided into seven main parts:

* [Ixian-Core](https://github.com/ProjectIxian/Ixian-Core): Functionality common to all other projects.
* [Ixian-DLT](https://github.com/ProjectIxian/Ixian-DLT): Implementation of the blockchain-processing part (the Master Node software).
* [Ixian-S2](https://github.com/ProjectIxian/Ixian-S2): Implementation of the streaming network (the S2 Node software).
* [Spixi](https://github.com/ProjectIxian/Spixi): Implementation of the SPIXI messaging client for Windows, Android and iOS.
* [Ixian-Miner](https://github.com/ProjectIxian/Ixian-Miner): Implementation of the Ixian standalone mining software.
* [Ixian-LiteWallet](https://github.com/ProjectIxian/Ixian-LiteWallet): Simple CLI wallet for the Ixian DLT network.
* [Ixian-Pool](https://github.com/ProjectIxian/Ixian-Pool): Mining pool software.

## About Ixian LiteWallet

Ixian Lite Wallet is a lightweight console executable which allows using an Ixian wallet without running a full Ixian-DLT Node.

## Running
Download the latest binary release or you can compile the code yourself.

### Windows
Double-click on the IxianLiteWallet.exe to start the wallet.

Expand Down Expand Up @@ -58,9 +80,19 @@ msbuild IxianLiteWallet.sln /p:Configuration=Release
```
The IxianLiteWallet will be compiled and placed in the IxianLiteWallet/bin/Release/ folder.

## Development branches

There are two main development branches:
* **master**: This branch is used to build the binaries for the official IXIAN DLT network. It should change slowly and be quite well-tested. This is also the default branch for anyone who wishes to build their Ixian software from source.
* **development**: This is the main development branch and the source for testnet binaries. The branch might not always be kept bug-free, if an extensive new feature is being worked on. If you are simply looking to build a current binary yourself, please use one of the release tags which will be associated with the master branch.

## Documentation

You can find more documentation on how to build, APIs and other documents on [Ixian Documentation Pages](https://docs.ixian.io).

## Get in touch / Contributing

If you feel like you can contribute to the project, or have questions or comments, you can get in touch with the team through Discord: (https://discord.gg/dbg9WtR)
If you feel like you can contribute to the project, or have questions or comments, you can get in touch with the team through Discord: https://discord.gg/pdJNVhv

## Pull requests

Expand All @@ -69,5 +101,4 @@ If you would like to send an improvement or bugfix to this repository, but witho
1. Fork this repository
2. Create a branch (preferably with a name that describes the change)
3. Create commits (the commit messages should contain some information on what and why was changed)
4. Create a pull request to this repository for review and inclusion.

4. Create a pull request to this repository for review and inclusion.

0 comments on commit bf2a8aa

Please sign in to comment.