-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
851540f
commit 6efcf69
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contribution Guide | ||
|
||
This guide will help you get set up on contributing to the netrunner comprehensive rules project. | ||
|
||
## Overview | ||
|
||
Overview of the folder structure in the project: | ||
|
||
``` | ||
- .github | files for github actions | ||
- data | input data for the document generation | ||
- rules_doc_generator | python project for the format conversion | ||
``` | ||
|
||
## Setup | ||
|
||
To get set up with the Python project you'll need at least Python 3.11 and install the required dependencies. | ||
|
||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
After that you can generate the output documents via the python module. | ||
|
||
``` | ||
python -m rules_doc_generator | ||
``` | ||
|
||
This will generate an output folder corresponding to each of the output formats (currently: `html` and `latex`). When making changes and pushing them to the repository, you should verify that the output can be generated and looks like you expect. |