mirror of
https://github.com/Cockatrice/Magic-Spoiler.git
synced 2026-03-21 17:54:59 -05:00
Update README.md
This commit is contained in:
parent
83d04f0242
commit
c7a64d89e6
15
README.md
15
README.md
|
|
@ -1,4 +1,4 @@
|
|||
[](https://github.com/Cockatrice/Magic-Spoiler/blob/files/spoiler.xml)
|
||||
[](https://github.com/Cockatrice/Magic-Spoiler/blob/files/spoiler.xml)
|
||||
|
||||
|
||||
# Magic-Spoiler [](https://gitter.im/Cockatrice/Magic-Spoiler) #
|
||||
|
|
@ -12,12 +12,12 @@ When run by Travis, the script automatically updates the files and uploads new v
|
|||
Travis CI is run daily on a cron job basis.
|
||||
|
||||
## Errors ##
|
||||
Noticed an error? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help!
|
||||
Noticed an error in the card data? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help!
|
||||
|
||||
## Running ##
|
||||
|
||||
### Requirements ###
|
||||
* Python 2.7
|
||||
* Python 3.6
|
||||
* several Python Modules (see [requirements.txt](https://github.com/Cockatrice/Magic-Spoiler/blob/master/requirements.txt))
|
||||
|
||||
```
|
||||
|
|
@ -27,17 +27,14 @@ pip install -r requirements.txt
|
|||
### Usage ###
|
||||
|
||||
```
|
||||
$> python main.py
|
||||
$> python -m magic_spoiler
|
||||
```
|
||||
|
||||
Outputs the following files to `out/` directory:<br>
|
||||
`spoiler.xml`, `{SETCODE}.xml`, `MPS_{SETCODE}.xml`,<br>
|
||||
`spoiler.json`, `{SETCODE}.json`, `MPS_{SETCODE}.json`
|
||||
`spoiler.xml`, `{SET_CODE}.xml`<br>
|
||||
`spoiler.json`, `{SET_CODE}.json`
|
||||
> **spoiler** → files contain all currently available spoilers from different sets<br>
|
||||
> **{SETCODE}** → files contain just the spoiler available for this single set<br>
|
||||
> **MPS_{SETCODE}** → files contain just the spoiler available for this [Masterpiece Series](http://magic.wizards.com/en/articles/archive/making-magic/masterpiece-series-2016-09-12)
|
||||
|
||||
Errors are logged there as well (`errors.yml`)
|
||||
|
||||
<br>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user