From 398ecf9f2539361ce86c0e5a798301b8649bd969 Mon Sep 17 00:00:00 2001 From: Christian Schabesberger Date: Sat, 10 Nov 2018 11:00:20 +0100 Subject: [PATCH] fix some parts and add description about documentation --- docs/00_Prepare_everything.md | 12 +++++++++--- docs/04_Run_changes_in_App.md | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/00_Prepare_everything.md b/docs/00_Prepare_everything.md index 7b05bb5..f439886 100644 --- a/docs/00_Prepare_everything.md +++ b/docs/00_Prepare_everything.md @@ -1,8 +1,14 @@ # 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 SoundCloud. Let's -dive right in. ;D +Welcome to the NewPipeExtractor documentation. This tutorial will guide you through the process of creating your own Extractor +service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud. +The whole documentation consists of this page, which explains the general concept of the NewPipeExtractor, as well as our +[Jdoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) setup. + +__IMPORTANT!!!__ this is likely to be the worst documentation you have ever red, so do not hesitate to +[report](https://github.com/teamnewpipe/documentation/issues) if +you find any (spelling)errors, incomplete parts or you simply don't understand something. We are an open community +and are open for everyone to help :) ## Setup your dev environment diff --git a/docs/04_Run_changes_in_App.md b/docs/04_Run_changes_in_App.md index 662f8ec..1749676 100644 --- a/docs/04_Run_changes_in_App.md +++ b/docs/04_Run_changes_in_App.md @@ -2,7 +2,7 @@ You should develop and test your changes with the JUnit environment that is provided by the NewPipe Extractor and IDEA. If you want to try it then with -the actual fronted you need to follow these changes. +the actual fronted you need to follow these steps. ### Setup Android Studio