Skip to content
This repository has been archived by the owner on Nov 8, 2021. It is now read-only.

Commit

Permalink
Merge pull request #190 from erciccione/rdm-build
Browse files Browse the repository at this point in the history
Updates to README
  • Loading branch information
erciccione authored Oct 5, 2020
2 parents 477a624 + 644ddc8 commit 404c4ac
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Branches available:
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 9 main chapters:
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**
---|---
Expand All @@ -48,7 +48,7 @@ To do so we use pandoc. If you wish to **build the guide by yourself**, you can
1. Download Pandoc, make and all necessary dependencies:
```
sudo apt install pandoc make
sudo apt install texlive texlive-xetex texlive-latex-extra
sudo apt install texlive texlive-xetex
```

2. From the source of the repository run:
Expand All @@ -59,17 +59,14 @@ For example, if you wish to build only the Spanish version in PDF format, you sh
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, which are:

- **Avoid** the use of **gender specific** terminology.
- If available, use the **glossary** for your language. This will help to keep translations consistent across different works. You can find all glossaries [here](https://github.com/monero-ecosystem/monero-translations/tree/master/terminology-guides).
- Read the guide '[Translation tips for Monero translators](https://github.com/monero-ecosystem/monero-translations/blob/master/translation-tips.md)'. **It contains all the information you need** to submit a perfect translation.
- If a string contains numbers, just keep them as they are.
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:
Expand All @@ -81,13 +78,6 @@ Adding a translation is very easy:

**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..).

### Support
If you need **help/support**, open an issue on this repository or contact ErCiccione. You can do so:

+ On the **live support chat of the localization workgroup**: `#monero-translations` (on IRC/Freenode, MatterMost, riot/matrix)
+ By **email**: translate[at]getmonero[dot]org
+ On **reddit**: just PM /u/erciccione

## 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:
 
Expand Down

0 comments on commit 404c4ac

Please sign in to comment.