The docs in this repo focus on the extractor, they don't explain the entirety of the newpipe codebase. This should be made clear everywhere it isn't, starting with the site name, so prospective contributors coming for an explanation of the architecture of the newpipe app's repo don't waste their time. |
||
---|---|---|
assets | ||
docs | ||
theme | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
copyright | ||
linkcheck.py | ||
mkdocs.yml | ||
requirements.txt |
README.md
NewPipe Tutorial
This is the tutorial for the NewPipeExtractor. It is for those who want to write their own service, or use NewPipeExtractor in their own projects.
This tutorial and the documentation are in an early state. So feedback is always welcome :D
The tutorial is created using mkdocs
. You can test and host it your self by running mkdocs serve
in the root
directory of this project. If you want to deploy your changes and you are one of the maintainers you can run mkdocs gh-deploy && git push
.
License
NewPipe is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.