From 2ea536a30b5bbe38ffc4027001ae9c4723bfdda4 Mon Sep 17 00:00:00 2001 From: Patricio Gonzalez Vivo Date: Sun, 24 Apr 2016 13:57:01 -0400 Subject: [PATCH] adding collaboration section --- README.md | 1 + appendix/README.md | 68 ++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 66 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e92c3d4..7c51e18 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ This is a gentle step-by-step guide through the abstract and complex universe of * [How can I navigate this book offline?](appendix/) * [How to run the examples on a RaspberryPi?](appendix/) * [How to print this book?](appendix/) + * [How can I collaborate?](appendix/) * [Examples Gallery](examples/) diff --git a/appendix/README.md b/appendix/README.md index 4f15eb1..af73c47 100644 --- a/appendix/README.md +++ b/appendix/README.md @@ -1,6 +1,4 @@ -# Appendix: Other ways to use this book - -This book is designed to be navigated with a modern web browser that supports WebGL technology (Firefox, Chrome, Safari, between others). But you may encounter the situation that you don't have a computer with no GPU card or not internet. If that's the case the following sections can help you. +# Appendix ## How can I navigate this book off-line? @@ -129,3 +127,67 @@ make If everything goes well, you will see a ```book.pdf``` file which you can read on your favorite device or print. +## How can I collaborate with this book? + +Thanks for be willing to collaborate! There are different ways you can do it: + +- Translating content +- Improving the [```glossary/``` section](https://github.com/patriciogonzalezvivo/thebookofshaders/tree/master/glossary) +- Editing content +- Sharing your shaders examples trough [the on-line editor](http://editor.thebookofshaders.com/) to + +### Translating content + +This book is wrote in [Markdown language](https://daringfireball.net/projects/markdown/syntax) so it's very easy to edit and work on it. + +1. Start by going to [github's repository at ```github.com/patriciogonzalezvivo/thebookofshaders```](https://github.com/patriciogonzalezvivo/thebookofshaders). Take a look the files and folders inside it. You will note that the content is on the ```README.md``` and others files with capital letters like: ```TITTLE.md```, ```SUMMARY.md```, etc. Also note that translations are hosted on files ending in two letters referencing the language they are on, ex.: ```README-jp.md```, ```README-es.md```, etc. + +2. Fork the repository and clone it in your computer. + +3. Duplicate the content of the files want to translate. Remember to add to the two letters that makes reference to the language you are translating to the files you will work on. + +4. Translate the contentent line by line (see **Translation notes**). + +5. Test it (see **Testing**). + +6. Push to your github fork and then make a [Pull Request]() + +#### Translating notes + +Do not erase or modify things the embebed examples, that looks like this: + +```html +
+``` + +or + +```html +
+``` + +#### Testing + +Start running a local PHP server inside the local repository folder: + +```bash +php -S localhost:8000 +``` + +Then in your browser search for ```localhost:8000``` go to the chapter you are translating and add ```?lan=``` followed by the to letters your use to mark the language you are translating to. + +For examples if you are translate the chapter ```03``` to french you had been working the file ```03/README-fr.md``` and you can test it by going to: ```http://localhost:8000/03/?lan=fr``` + +### Improving the glossary section + +This section is under development. We are happy to listen to your ideas on how to make it a friendly tools for all. Send us a message to [@bookofshaders](https://twitter.com/bookofshaders). + +### Editing content + +We are all humans. If you see something say something and make a Pull Request or open an issue. Thanks! + +### Sharing your shaders examples + +You will see a lot of links to [the on-line editor](http://editor.thebookofshaders.com/) and embebed instances of it. +Once you code something that makes you proud, click the "Export" (or the ```⇪``` icon) and then copy the "URL to code...". Send it to [@bookofshaders](https://twitter.com/bookofshaders) or [@kyndinfo](https://twitter.com/kyndinfo). We are looking forward to see it and add it to [the example gallery section](http://thebookofshaders.com/examples/). +