Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monero-ecosystem/monero-gui-guide

Guide for the Monero GUI wallet
https://github.com/monero-ecosystem/monero-gui-guide

gui guide hacktoberfest monero

Last synced: 3 days ago
JSON representation

Guide for the Monero GUI wallet

Awesome Lists containing this project

README 

        
## Guide for the Monero GUI wallet



This repository contains the guide for the [Monero GUI Wallet](https://github.com/monero-project/monero-gui/releases).

This document is meant to be updated continuously and **a new major release will be available whenever Monero publishes a new version of the GUI**.

 



The guide is composed by several different markdown files (see the chapter 'structure'). For simplicity, we have an easy-to-consult version:

 



**[monero-GUI-guide.md](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/monero-GUI-guide.md)**



### Versions and branches

The links above are for the **upstream version of the guide**. In other words, they are synced with the *master* branch of the Monero GUI wallet.

 



If you are looking for the guide for a specific GUI release, change the branch of this repository.  

Branches available:



+ **[1.5](https://github.com/monero-ecosystem/monero-GUI-guide/tree/1.5)**: Monero GUI 0.13.0.3 and 0.13.0.4 'Beryllium Bullet'

+ **[1.6](https://github.com/monero-ecosystem/monero-GUI-guide/tree/1.6)**: Monero GUI wallet version 0.14.1



 



For **PDF** and **EPUB** versions, check out the [latest Release](https://github.com/monero-ecosystem/monero-GUI-guide/releases).



## Structure and guidelines for contributors

The original guide can be found in the [en](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en) folder. It's divided in 12 chapters:



**Chapter**|**Content**

---|--- 

00 | [Preface](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch00.md)

01 | [Welcome](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch01.md)

02 | [Create a Wallet](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch02.md)

03 | [Synchronization](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch03.md)

04 | [Monero Account](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch04.md)

05 | [Send Monero](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch05.md)

06 | [Receive Monero](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch06.md)

07 | [Transaction History](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch07.md)

08 | [Advanced Features](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch08.md)

09 | [Settings](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch09.md)

10 | [Binaries Verification](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch10.md)

11 | [About Remote Nodes](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch11.md)

12 | [Common Issues and Solutions](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/en/ch12.md)



These single chapters can be built in a single file in 3 different formats: **HTML**, **PDF** and **EPUB**.  

To do so we use pandoc. If you wish to **build the guide by yourself**, you can do it following these steps (on Linux):



1. Download Pandoc, make and all necessary dependencies:

```

sudo apt install pandoc make

sudo apt install texlive texlive-xetex

```



2. From the source of the repository run:

```

make [format][-language]

```

For example, if you wish to build only the Spanish version in PDF format, you should run `make pdf-es`.  

If you want all languages in a single format: `make epub`- This will give you the epub version in all languages.  

If you want to build all formats for all available languages: `make all` - This will build the guide in PDF, HTML and EPUB in all available languages.



The markdown version is built using `pandoc *.md  -o  monero-GUI-guide.md --toc -s --variable documentclass:report`. The header is added manually.



### Contribute!

Improvements are always welcome. Feel free to propose a change using the issue tracker or opening a pull request.  

If you wish to contribute, please **do not** edit the file *monero-GUI-guide.md*. That's just temporary and it gets built manually. Work ONLY on the *.md* files inside the 'en' folder. Every pull request with changes to *monero-GUI-guide.md* will be rejected.



## Translations

Before adding a translation, please keep in mind the [general guidelines for Monero translators](https://github.com/monero-ecosystem/monero-translations). Contact the localization workgroup or open an issue if you need help.



### Steps

Adding a translation is very easy:



1. Copy the *en* folder with all its content (including the 'makefile') and rename the new folder with the codename of your language (for example */it* for Italian).

2. Translate all the text you find, except for code and html.

3. Edit the string `LANGUAGES =` in the main makefile, after 'en' (or the previous added language) add the name of the folder which contains your translations.

4. Push the changes to your local branch and open a pull request.



**Do not edit** the files contained in the /translations folder. They are manually built. All changes MUST be done on the appropriate source folder (/en for English, /es for Spanish, etc..).



## Donations

The creation and maintainance of this guide require a lot of hours of work. I think it's a very useful document and I'm happy to work on it voluntarily. The only problem is that the creation/maintainance of the guide **requires** a high consumption of beer. If you would like to help me refill my fridge and show the middle finger to my liver, consider donating to this Monero address:

 



84fCZdZik8KauctPhh6ZQ1KgMb99zpKKQWvR6kSCedtr4L596YjLiaaFYqhUU9pV6qXWjTLoNWUVCiKinC9uFKuq8azHTit