darigovresearch / Intro-to-DIY-Off-Grid-Systems

Repository containing source files of Demand for Energy Equality's guide on "Intro​​ ​​to​​ ​​DIY​​ ​​Off​​ ​​Grid​​ ​​Systems" in a machine readable format to increase accessibility, improvements, corrections and speed of translation
2 stars 1 forks source link

Intro-to-DIY-Off-Grid-Systems

Repository containing source files of Demand for Energy Equality's guide on "Intro to DIY Off Grid Systems" in a machine readable format to increase accessibility, improvements, corrections and speed of translation

Introduction

This repository has taken the content of the "Intro to DIY Off Grid Systems" PDF and put them into a form which can be easily corrected, improved and translated by the community using LaTeX a markdown language for technical topics.

Notes

Please note the modifications which have been made & where you can find updates.

  1. All the content of the PDF and put them into a form which can be easily corrected, improved and translated by the community using LaTeX a markdown language for technical topics.
  2. Any updates, corrections or translations to the PDF will be available at https://github.com/darigovresearch/Intro-to-DIY-Off-Grid-Systems so do return periodically to check if you have the latest version.
  3. Modifications from the original work includes typo correction, card merging & consistency consolidation (see the commit history for [en] for the specific changes if any).

Feel free to share the PDFs and give the repository a star so more people are likely to see this work and can get the most out of it.

Usage

If you're just looking for the content, find the relevant PDF file in your language in the table below or by navigating the folder structure above and click the download button. If you're looking for the source it is in the relevant language subfolder of this folder. To build these PDFs we have been using Sublime Text with a LaTeX addon to help build it faster, better and more accurately than with other tools but you can use whatever works best for you.

The original file can be previewed here and downloaded here

Language code Language Title Status Preview Download
ar Arabic TODO Pending Translation, want to help? TODO TODO
el Greek TODO Pending Translation, want to help? TODO TODO
en English Intro to DIY Off Grid Systems In progress here here
es Spanish TODO Pending Translation, want to help? TODO TODO
fr French Introduction aux systèmes hors réseau DIY Translation in progress, want to help? here here
it Italian TODO Pending Translation, want to help? TODO TODO
ru Russian TODO Pending Translation, want to help? TODO TODO
sh Serbo-Croatian TODO Pending Translation, want to help? TODO TODO
zh Chinese TODO Pending Translation, want to help? TODO TODO

We have also been experimenting with a sphinx-based version at this URL which may end up being easier to convert to offline pdfs & a more interactive site.

Potential Improvements Yet to be Made

  1. To find a way to systematically pull the content if there are any updates from the original source in the future.
    • Currently this was all done manually.
  2. We would like to be able to translate the content for different languages so other people who don't speak English can learn this topic or be able to make textbooks for other languages as well.
  3. Turn the content into a set of flashcards to learn about the topic and make it even more accessible to learn & revise.

Contributing

Pull requests, corrections, translations & fixes are welcome. Any contributions must be submitted under the same license that the original piece of work (see below). Take a look at any open issues or submit new ones if there is something that needs to be fixed or added.

Watch our video on how to contribute to open source for a complete overview -> https://www.youtube.com/watch?v=UWA4wyacY2A

Translating for other languages

Translations in all languages are welcome. Send a pull request or open an issue any time of day or night.

Please prepend the tag [lang-code] to your issues and pull requests. For example, [fr] for French. This will help everyone pick out things they care about.

We're happy for any contribution in any form, but if you're making more than one major change (i.e. translations for two different languages) it would be super cool of you to make a separate pull request for each one so that someone can review them more effectively and/or individually.

See CONTRIBUTING.md for more guidance and details for making a contribution.

License

Unless otherwise specified, everything in this repository is covered by the following licence:

Creative Commons License

This work was based on the work Intro to DIY Off Grid Systems by Demand Energy Equality, licensed under a Creative Commons BY-SA.

To see this work in full go to https://www.demandenergyequality.org/get-started-with-offgrid


The creation, maintenance and continued development of this project is made possible
thanks to our Patreon and Direct supporters!
Consider joining them if you think this project has earned it!