add Prepare Everything page

add Prepare Everything page
This commit is contained in:
Christian Schabesberger 2018-02-22 17:11:19 +01:00
parent 855803370e
commit 3c42a9febc
8 changed files with 265 additions and 2 deletions

View File

@ -0,0 +1,36 @@
# Prepare everything
Welcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor service
with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SournCloud.
Let's dive right. ;D
## Setup your dev environment
First and foremost you need to meet certain conditions in order to write your own service.
### What you need to know
- Basic understanding of __[git](https://try.github.io)__
- Good __[Java](http://whatpixel.com/best-java-books/)__ knowledge
- Good understanding of __[web technology](https://www.w3schools.com/)__
- Basic understanding about __[unit testing](http://www.vogella.com/tutorials/JUnit/article.html)__ and __[JUnit](https://junit.org/)__
- Flawless understanding of how to [contribute](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution) to the __NewPipe project__
### What you need to have
- A dev environment/ide that supports:
- __[git](https://git-scm.com/downloads/guis)__
- __[java 8](https://www.java.com/en/download/faq/java8.xml)__
- __[gradle](https://gradle.org/)__
- I highly recomend [IDEA Community](https://www.jetbrains.com/idea/) since it has everything we need.
- A __[github](https://github.com/)__ account
- A loot of patience and excitement ;D
After making sure all these conditions are provided fork the [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),
using the [fork button](https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box).
This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.
Next import the cloned project into your [ide](https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project)
and [run](https://www.jetbrains.com/help/idea/performing-tests.html) it.
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.
![tests passed on idea](img/prepare_tests_passed.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@ -0,0 +1,181 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>00 PrepareEverything - NewPipe Documentation</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "00 PrepareEverything";
</script>
<script src="../js/jquery-2.1.1.min.js"></script>
<script src="../js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> NewPipe Documentation</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li>
<li class="toctree-l1 ">
<a class="" href="..">Home</a>
</li>
<li>
<li>
<li class="toctree-l1 current">
<a class="current" href="./">00 PrepareEverything</a>
<ul>
<li class="toctree-l3"><a href="#prepare-everything">Prepare everything</a></li>
<li><a class="toctree-l4" href="#setup-your-dev-environment">Setup your dev environment</a></li>
</ul>
</li>
<li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">NewPipe Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>00 PrepareEverything</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="prepare-everything">Prepare everything</h1>
<p>Welcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor service
with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SournCloud.
Let's dive right. ;D</p>
<h2 id="setup-your-dev-environment">Setup your dev environment</h2>
<p>First and foremost you need to meet certain conditions in order to write your own service.</p>
<h3 id="what-you-need-to-know">What you need to know</h3>
<ul>
<li>Basic understanding of <strong><a href="https://try.github.io">git</a></strong></li>
<li>Good <strong><a href="http://whatpixel.com/best-java-books/">Java</a></strong> knowledge</li>
<li>Good understanding of <strong><a href="https://www.w3schools.com/">web technology</a></strong></li>
<li>Basic understanding about <strong><a href="http://www.vogella.com/tutorials/JUnit/article.html">unit testing</a></strong> and <strong><a href="https://junit.org/">JUnit</a></strong></li>
<li>Flawless understanding of how to <a href="https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution">contribute</a> to the <strong>NewPipe project</strong></li>
</ul>
<h3 id="what-you-need-to-have">What you need to have</h3>
<ul>
<li>A dev environment/ide that supports:<ul>
<li><strong><a href="https://git-scm.com/downloads/guis">git</a></strong></li>
<li><strong><a href="https://www.java.com/en/download/faq/java8.xml">java 8</a></strong></li>
<li><strong><a href="https://gradle.org/">gradle</a></strong></li>
<li>I highly recomend <a href="https://www.jetbrains.com/idea/">IDEA Community</a> since it has everything we need.</li>
</ul>
</li>
<li>A <strong><a href="https://github.com/">github</a></strong> account</li>
<li>A loot of patience and excitement ;D</li>
</ul>
<p>After making sure all these conditions are provided fork the <a href="https://github.com/TeamNewPipe/NewPipeExtractor">NewPipeExtractor</a>,
using the <a href="https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box">fork button</a>.
This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.
Next import the cloned project into your <a href="https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project">ide</a>
and <a href="https://www.jetbrains.com/help/idea/performing-tests.html">run</a> it.
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.
<img alt="tests passed on idea" src="../img/prepare_tests_passed.png" /></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
</span>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@ -62,6 +62,13 @@
</ul> </ul>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="00_PrepareEverything/">00 PrepareEverything</a>
</li> </li>
<li> <li>
@ -108,6 +115,13 @@ This however is not the <a href="https://teamnewpipe.github.io/NewPipeExtractor/
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="00_PrepareEverything/" class="btn btn-neutral float-right" title="00 PrepareEverything"/>Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/> <hr/>
@ -131,6 +145,8 @@ This however is not the <a href="https://teamnewpipe.github.io/NewPipeExtractor/
<span style="margin-left: 15px"><a href="00_PrepareEverything/" style="color: #fcfcfc">Next &raquo;</a></span>
</span> </span>
</div> </div>
@ -139,5 +155,5 @@ This however is not the <a href="https://teamnewpipe.github.io/NewPipeExtractor/
<!-- <!--
MkDocs version : 0.14.0 MkDocs version : 0.14.0
Build Date UTC : 2018-02-20 23:07:07.957573 Build Date UTC : 2018-02-22 16:11:04.493055
--> -->

View File

@ -14,6 +14,21 @@
"location": "/#stay-tuned", "location": "/#stay-tuned",
"text": "Tune yourself to stay ;D", "text": "Tune yourself to stay ;D",
"title": "Stay Tuned" "title": "Stay Tuned"
},
{
"location": "/00_PrepareEverything/",
"text": "Prepare everything\n\n\nWelcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor service\nwith which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SournCloud.\nLet's dive right. ;D\n\n\nSetup your dev environment\n\n\nFirst and foremost you need to meet certain conditions in order to write your own service.\n\n\nWhat you need to know\n\n\n\n\nBasic understanding of \ngit\n\n\nGood \nJava\n knowledge\n\n\nGood understanding of \nweb technology\n\n\nBasic understanding about \nunit testing\n and \nJUnit\n\n\nFlawless understanding of how to \ncontribute\n to the \nNewPipe project\n\n\n\n\nWhat you need to have\n\n\n\n\nA dev environment/ide that supports:\n\n\ngit\n\n\njava 8\n\n\ngradle\n\n\nI highly recomend \nIDEA Community\n since it has everything we need.\n\n\n\n\n\n\nA \ngithub\n account\n\n\nA loot of patience and excitement ;D\n\n\n\n\nAfter making sure all these conditions are provided fork the \nNewPipeExtractor\n,\nusing the \nfork button\n.\nThis way you have your own working repository. Now clone this repository into your local folder in which you want to work in.\nNext import the cloned project into your \nide\n\nand \nrun\n it.\nIf all the checks are green you did everything right, and you are good to go to move on to the next chapter.",
"title": "00 PrepareEverything"
},
{
"location": "/00_PrepareEverything/#prepare-everything",
"text": "Welcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor service\nwith which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SournCloud.\nLet's dive right. ;D",
"title": "Prepare everything"
},
{
"location": "/00_PrepareEverything/#setup-your-dev-environment",
"text": "First and foremost you need to meet certain conditions in order to write your own service. What you need to know Basic understanding of git Good Java knowledge Good understanding of web technology Basic understanding about unit testing and JUnit Flawless understanding of how to contribute to the NewPipe project What you need to have A dev environment/ide that supports: git java 8 gradle I highly recomend IDEA Community since it has everything we need. A github account A loot of patience and excitement ;D After making sure all these conditions are provided fork the NewPipeExtractor ,\nusing the fork button .\nThis way you have your own working repository. Now clone this repository into your local folder in which you want to work in.\nNext import the cloned project into your ide \nand run it.\nIf all the checks are green you did everything right, and you are good to go to move on to the next chapter.",
"title": "Setup your dev environment"
} }
] ]
} }

View File

@ -51,6 +51,13 @@
<li class="toctree-l1 "> <li class="toctree-l1 ">
<a class="" href=".">Home</a> <a class="" href=".">Home</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="00_PrepareEverything/">00 PrepareEverything</a>
</li> </li>
<li> <li>

View File

@ -4,7 +4,15 @@
<url> <url>
<loc>None/</loc> <loc>None/</loc>
<lastmod>2018-02-21</lastmod> <lastmod>2018-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/00_PrepareEverything/</loc>
<lastmod>2018-02-22</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>