Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Arthur Silva committed Dec 12, 2016
1 parent c36ac74 commit 6a61f8b
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ $ go get github.com/XML-Comp/XML-Comp
$ XML-Comp -comp -original /path/to/language/english -translation /path/to/language/translation
```

### How this works? - RimWorld translator
### How this works?
You need two paths that we call "original" & "translation", which are described bellow:
- "original": Full path directory of your RimWorld English folder
- **`"original"`**: Full path directory of your RimWorld English folder
- **`"translation"`**: Full path directory of your RimWorld ~Language~ folder cloned from [GitHub](https://github.com/ludeon)

My path - as an example: "original" = **/Users/arthur/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Mods/Core/Languages/English**
- "translation": Full path directory of your RimWorld ~Language~ folder cloned from [GitHub](https://github.com/ludeon)
My "original" path: **`/Users/arthur/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Mods/Core/Languages/English`**

Me again: "translation" = **/Users/arthur/Github/RimWorld-PortugueseBrazilian**
My "translation" path: **`/Users/arthur/Github/RimWorld-PortugueseBrazilian`**

With these paths in hand you run our program and It will let you know in a `missingSomethieng.txt` file what is missing and where in your translation! That simple!

Expand All @@ -39,6 +39,4 @@ $ go install
$ xml-comp help
```

#### To Do - Check our [Issues](https://github.com/XML-Comp/XML-Comp/issues) & [Milestones]()
- [GUI](https://github.com/XML-Comp/XML-Comp/issues/10)
- [Installer](https://github.com/XML-Comp/XML-Comp/issues/12)
#### To Do - Check our [Issues](https://github.com/XML-Comp/XML-Comp/issues) & [Milestones]()

0 comments on commit 6a61f8b

Please sign in to comment.