Andreas/DF-Walkthrough
1
0
Fork 0
mirror of https://github.com/PeridexisErrant/DF-Walkthrough.git synced 2025-09-22 05:40:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve contributing page

Browse source
This commit is contained in:
PeridexisErrant 2015-10-22 09:39:31 +11:00
parent 0705f4de47
commit 4b48c4effb
2 changed files with 24 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

8
index.rst
View file

@ -88,9 +88,11 @@ The source text and images are `hosted on Github
published immediately to `readthedocs.org <https://df-walkthrough.rtfd.org>`_
every time a change is pushed.
Inspiration and original text - from which I learnt to play DF - by
`TinyPirate <http://afteractionreporter.com/dwarf-fortress-tutorials/>`_,
adapted with :reddit:`permission <368j7h>`.
This project was inspired by `TinyPirate's DF tutorials
<http://afteractionreporter.com/dwarf-fortress-tutorials/>`_, which taught
me to play DF. The walkthrough started as an update of these tutorials.
Other content is original or (for some tutorials and most masterclasses)
links back to the primary source.
Consider `supporting my work <https://www.patreon.com/PeridexisErrant>`_
on Patreon.

40
misc/contributing.rst
View file

@ -5,30 +5,26 @@ Contributing to this project
Are you interested in contributing to this project, or just interested
in learning what goes into it? Then this is the page for you!
There are two main areas of work: maintaining and improving the
existing content (walkthrough chapters and tutorials), and adding
new tutorials.
At the moment I'm focussing on updating Tiny Pirate's
`old tutorials <http://afteractionreporter.com/dwarf-fortress-tutorials/>`_ -
the chapters are written for DF v0.28.181.40d, which was
released in 2008!
If you want to help out by improving existing chapters and tutorials,
that would be much appreciated. I'm also very happy to take bug reports!
(for the updated chapters, anyway - I know the old ones are old!)
You can `find the project on Github
<https://github.com/PeridexisErrant/DF-Walkthrough>`_.
If this sounds like a lot of work - and it is - you can
`support me on Patreon <https://www.patreon.com/PeridexisErrant>`_ instead.
There are two main areas of work: maintaining and improving the
existing content (walkthrough chapters and tutorials), and adding
new tutorials. It would be great if you wanted to help out!
I'm also very happy to take bug reports - just send me a message about
small errors, typos, or formatting problems. Larger issues about content
should be reported on the Github issue tracker, so I'm not the only one
who can work on them.
You can also `support me on Patreon <https://www.patreon.com/PeridexisErrant>`_
if this sounds like a lot of work.
How to turn text into the website
=================================
Anyone who wants to contribute content, fix a bug, or just have an offline
copy need to turn the text files into the website. Luckily, this is
copy needs to turn the text files into the website. Luckily, this is
pretty easy! You only need two things installed:
* `Python <https://www.python.org>`_.
@ -41,7 +37,7 @@ pretty easy! You only need two things installed:
alternative install instructions.
Get the code from the GitHub repo, either by forking the repo if you want
to contribute), or usig the 'download ZIP' option and unzipping the folder.
to contribute, or using the 'download ZIP' option and unzipping the folder.
Congratulations, you now have the text! There's only one more step:
open a command prompt in the DF-Walkthrough folder, and run ``make html``
@ -58,10 +54,9 @@ add yourself if you're not!*
Person Contribution
=================== ===========================================================
PeridexisErrant Project leader, does some of everything else too
TinyPirate Author of old "Getting Started with Dwarf Fortress"
series, inspiration for project
/u/buschwacker Contributed many images
/u/Mechanixm Wrote several excellent tutorials
TinyPirate Author and inspiration for project
/u/buschwacker Contributed chapters and many, many images
/u/Mechanixm Wrote a great masterclass series
=================== ===========================================================
@ -82,6 +77,9 @@ The tutorials each cover a single, self-contained topic. Tutorials
are aimed at players who have just finished the walkthrough. They
introduce core topics not covered in the walkthrough.
A masterclass is like a tutorial, but covering an advanced topic for
experienced players.
Style
-----