From: hyeonseok lee Date: Wed, 3 Mar 2021 09:52:17 +0000 (+0900) Subject: Fix md file link X-Git-Tag: submit/tizen/20210317.111732~19 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=03faa5d00cde9bc7a11b5fd4747d50502f0bc110;p=platform%2Fupstream%2Fnnstreamer.git Fix md file link 1. Fix all the md files in $NNST_ROOT/*.md $NNST_ROOT/Documentation/*.md $NNST_ROOT/tools/*md which has a link to other md files Signed-off-by: hyeonseok lee --- diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e7032dd..71ae5f1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -52,6 +52,6 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor This Code of Conduct is a modified one from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]. -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01a1328..346c478 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ If there is no chairperson or its deputy available, the most senior among availa Anyone who has been contributed to the repository by submitting a pull-request and have it reviewed, accepted, and merged by committers is a contributor. -Each contributor should comply with the [Code of Conduct](https://github.com/nnstreamer/nnstreamer/blob/master/CODE_OF_CONDUCT.md), this document (CONTRIBUTING.md), and [the Linux Foundation's policies](http://lfprojects.org/policies/). +Each contributor should comply with the [Code of Conduct](CODE_OF_CONDUCT.md), this document (CONTRIBUTING.md), and [the Linux Foundation's policies](https://lfprojects.org/policies/). Every contributor is able and encouraged to review codes and to participate in other developmental activities. @@ -69,7 +69,7 @@ A committer may be retired by approvals of more than half of the committers. Alternatively, TSC may decide to elect or to retire a committer with TSC voting as well or amend the rules on how to elect/retire committers. -Each committer is also a contributor and should comply with the [Code of Conduct](https://github.com/nnstreamer/nnstreamer/blob/master/CODE_OF_CONDUCT.md), this document (CONTRIBUTING.md), and [the Linux Foundation's policies](http://lfprojects.org/policies/). +Each committer is also a contributor and should comply with the [Code of Conduct](CODE_OF_CONDUCT.md), this document (CONTRIBUTING.md), and [the Linux Foundation's policies](https://lfprojects.org/policies/). The committers are: diff --git a/Documentation/component-description.md b/Documentation/component-description.md index 3470288..42443fa 100644 --- a/Documentation/component-description.md +++ b/Documentation/component-description.md @@ -59,8 +59,8 @@ In this page, we focus on the status of each elements. For requirements and desi - SNPE (stable) - Vivante (stable) - WIP: SNAP (Exynos-NPU & Qualcomm-SNPE), ... - - [Guide on writing a filter subplugin](Documentation/writing-subplugin-tensor-filter.md) - - [Codegen and code template for tensor\_filter subplugin](https://github.com/nnstreamer/nnstreamer-example/tree/master/templates) + - [Guide on writing a filter subplugin](writing-subplugin-tensor-filter.md) + - [Codegen and code template for tensor\_filter subplugin](https://github.com/nnstreamer/nnstreamer-example/tree/main/templates) - [tensor\_sink](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_sink) (stable) - [tensor\_transform](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_transform) (stable) - Supported features @@ -84,7 +84,7 @@ In this page, we focus on the status of each elements. For requirements and desi - [tensor\_mux](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_mux) (stable) - [tensor\_demux](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_demux) (stable) - [tensor\_source](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_source) (stable for IIO. More sources coming soon) -- [tensor\_aggregator](https://github.com/nnstreamer/nnstreamer/tree/main//gst/nnstreamer/tensor_aggregator) (stable) +- [tensor\_aggregator](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_aggregator) (stable) - [tensor\_repo\_sink](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_repo) (stable) - [tensor\_repo\_src](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_repo) (stable) - [tensor\_src\_iio](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_source) (stable) @@ -111,7 +111,7 @@ Note that test elements in /tests/ are not elements for applications. They exist - JAVA-API (Android) - [Android sample app](https://github.com/nnstreamer/nnstreamer-example/tree/master/android/example_app/api-sample) uses JAVA APIs to implement Android-NNStreamer apps. - [Available at JCenter](https://bintray.com/beta/#/nnsuite/nnstreamer?tab=packages) - - Note that the Android Sample Applications published via Google Play Store, [Source Code](https://github.com/nnstreamer/nnstreamer-example/tree/master/android/example_app), are developed before NNStreamer Java API. They use GStreamer functions. + - Note that the Android Sample Applications published via Google Play Store, [Source Code](https://github.com/nnstreamer/nnstreamer-example/tree/main/android/example_app), are developed before NNStreamer Java API. They use GStreamer functions. - Web API (HTML5) Planned (Tizen 7.0?) - Python API Planned (Tizen 7.0?) diff --git a/Documentation/contributing.md b/Documentation/contributing.md index a4a6fef..cf5a707 100644 --- a/Documentation/contributing.md +++ b/Documentation/contributing.md @@ -10,7 +10,7 @@ Consistent code conventions are important for several reasons: * To make it easy to debug the code, with both a system call tracer and GNU debuggers. It should be easy to set breakpoints, view locals, and display and view data structures. * To attempt to improve code quality through consistency, and requiring patterns that are less likely to result in bugs either initially, or after code modification. -For more information, please refer to [coding-convention.md](https://github.com/nnstreamer/nnstreamer/blob/main/Documentation/coding-convention.md). +For more information, please refer to [coding-convention.md](coding-convention.md). For C code, you may use [gst-indent](https://github.com/nnstreamer/nnstreamer/blob/main/tools/development/gst-indent). @@ -42,7 +42,7 @@ The submitter has the first responsibility of keeping the created PR clean and n A PR is required to meet the following criteria. * It has passed all the tests defined for TAOS-CI. - This includes unit tests and integration tests in various platforms and different static analysis tools. - - Note that one of the tests includes the "Signed-off-by" check, which means that the author has agreed with [Code of Conduct](https://github.com/nnstreamer/nnstreamer/blob/main/CODE_OF_CONDUCT.md). You may need to refer to later section. + - Note that one of the tests includes the "Signed-off-by" check, which means that the author has agreed with [Code of Conduct](../CODE_OF_CONDUCT.md). You may need to refer to later section. * At least TWO committers (reviewers with voting rights, elected by TSC or other committers) have approved the PR. - This is a necessary condition, not sufficient. - If the PR touches sensitive codes or may affect wide ranges of components, reviewers will wait for other reviewers to back them up. diff --git a/Documentation/data-type-and-flow-control.md b/Documentation/data-type-and-flow-control.md index 550a71f..43c9146 100644 --- a/Documentation/data-type-and-flow-control.md +++ b/Documentation/data-type-and-flow-control.md @@ -2,7 +2,7 @@ title: Data type and flow control ... -[Rank counting with other/tensor types](Documentation/rank-counting-with-other-tensor.md) +[Rank counting with other/tensor types](rank-counting-with-other-tensor.md) # GStreamer data types (pad capabilities) @@ -100,7 +100,7 @@ We have the following principles for timestamp policies. Timestamping policies o Besides timestamping, we have additional synchronization issues when there are merging streams. We need to determine which frames are going to be merged (or muxed) when we have multiple available and unused frames in an incoming sink pad. In general, we might say that the synchronization of frames determines which frames to be used for mux/merge and timestamping rule determins which timestamp to be used among the chosen frames for mux/merge. In principle and by default, - If there are mutliple unused and available frames in a sink pad, unlike most media filters, we take a buffer that arrived most recently. -- For more about the synchronization policies, see [Synchronization policies at Mux and Merge](synchronization-policies-at-mux-and-merge.md) +- For more about the synchronization policies, see [Synchronization policies at Mux and Merge](synchronization-policies-at-mux-merge.md) ### Leaky Queue diff --git a/Documentation/doxygen-documentation.md b/Documentation/doxygen-documentation.md index 3698667..11b12c6 100644 --- a/Documentation/doxygen-documentation.md +++ b/Documentation/doxygen-documentation.md @@ -30,7 +30,7 @@ Doxygen is the de facto standard tool for generating documentation from annotate ``` # for src app $ cd ./gst - $ doxygen ../Doxyfile.prj # from https://github.com/nnstreamer/TAOS-CI/blob/master/ci/Doxyfile.prj + $ doxygen ../Doxyfile.prj # from https://github.com/nnstreamer/TAOS-CI/blob/main/ci/Doxyfile.prj # launch with the browser to view the results $ chromium-browser ./html/index.html diff --git a/Documentation/edge-ai.md b/Documentation/edge-ai.md index dd36084..c1d3451 100644 --- a/Documentation/edge-ai.md +++ b/Documentation/edge-ai.md @@ -24,16 +24,16 @@ Example shows how to implement edge AI using NNStreamer. These examples are tested using Ubuntu PC and Raspberry PI. - * [Image Classification](https://github.com/nnstreamer/nnstreamer-example/tree/master/Tizen.platform/Tizen_IoT_ImageClassification) + * [Image Classification](https://github.com/nnstreamer/nnstreamer-example/tree/main/Tizen.platform/Tizen_IoT_ImageClassification) The device analyzes the camera image before transmitting it, and then transmits meaningful information only. In this example, if the device finds a target that the user wants, it starts video streaming to the server. - * [Text Classification](https://github.com/nnstreamer/nnstreamer-example/tree/master/Tizen.platform/Tizen_IoT_text_classification_NonGUI) + * [Text Classification](https://github.com/nnstreamer/nnstreamer-example/tree/main/Tizen.platform/Tizen_IoT_text_classification_NonGUI) Text classifications are classified into predefined groups based on sentences. - * [Image segmentation on edgeTPU](https://github.com/nnstreamer/nnstreamer-example/tree/master/bash_script/example_image_segmentation_tensorflow_lite) + * [Image segmentation on edgeTPU](https://github.com/nnstreamer/nnstreamer-example/tree/main/bash_script/example_image_segmentation_tensorflow_lite) Image segmentation is the process of partitioning a digital image into multiple segments. diff --git a/Documentation/getting-started-tizen.md b/Documentation/getting-started-tizen.md index d720b5f..7aea19d 100644 --- a/Documentation/getting-started-tizen.md +++ b/Documentation/getting-started-tizen.md @@ -56,4 +56,4 @@ You will need root permission and your device should be unlocked or SMACK should ### Additional materials for Tizen developers -[Writing Tizen Native Apps with NNStreamer / ML APIs](Documentation/writing-tizen-native-apps.md) +[Writing Tizen Native Apps with NNStreamer / ML APIs](writing-tizen-native-apps.md) diff --git a/Documentation/getting-started-ubuntu-ppa.md b/Documentation/getting-started-ubuntu-ppa.md index 9a4b5ca..108b059 100644 --- a/Documentation/getting-started-ubuntu-ppa.md +++ b/Documentation/getting-started-ubuntu-ppa.md @@ -37,8 +37,8 @@ $ sudo apt install nnstreamer You need to rebuild nnstreamer's corresponding subplugins (e.g., nnstreamer-tensorflow) with the nerual network framework version you want to use. -* You may configure/update, build with pdebuild/debuild, and install its resulting .deb packages [Ubuntu: Pbuilder / Pdebuild](Documentation/getting-started-ubuntu-debuild.md). -* You may configure/update, build with meson/ninja, and install binraies with ninja [Linux generic: build with meson and ninja](Documentation/getting-started-meson-build.md): For advanced users with feature customization. +* You may configure/update, build with pdebuild/debuild, and install its resulting .deb packages [Ubuntu: Pbuilder / Pdebuild](getting-started-ubuntu-debuild.md). +* You may configure/update, build with meson/ninja, and install binraies with ninja [Linux generic: build with meson and ninja](getting-started-meson-build.md): For advanced users with feature customization. * Be careful on install paths and duplicated installation. You need to check the configuration (/etc/nnstreamer.ini and env-vars) #### Unsafe method (no need for rebuild) diff --git a/Documentation/getting-started.md b/Documentation/getting-started.md index 468f608..4264068 100644 --- a/Documentation/getting-started.md +++ b/Documentation/getting-started.md @@ -4,8 +4,8 @@ title: Getting Started ## Getting Started -### [Ubuntu: PPA Install](Documentation/getting-started-ubuntu-ppa.md): Recommended to most users -### [Ubuntu: Pbuilder / Pdebuild](Documentation/getting-started-ubuntu-debuild.md): Create .deb packages -### [Linux generic: build with meson and ninja](Documentation/getting-started-meson-build.md): For advanced users with feature customization -### [Tizen: gbs](Documentation/getting-started-tizen.md): Build RPM packages for Tizen -### [macOS](Documentation/getting-started-macos.md) +### [Ubuntu: PPA Install](getting-started-ubuntu-ppa.md): Recommended to most users +### [Ubuntu: Pbuilder / Pdebuild](getting-started-ubuntu-debuild.md): Create .deb packages +### [Linux generic: build with meson and ninja](getting-started-meson-build.md): For advanced users with feature customization +### [Tizen: gbs](getting-started-tizen.md): Build RPM packages for Tizen +### [macOS](getting-started-macos.md) diff --git a/Documentation/how-to-run-examples.md b/Documentation/how-to-run-examples.md index f1ff319..8370753 100644 --- a/Documentation/how-to-run-examples.md +++ b/Documentation/how-to-run-examples.md @@ -40,7 +40,7 @@ $ cd /usr/lib/nnstreamer/bin As of 2018/10/13, we support 16.04 and 18.04 ## Build examples (Ubuntu 16.04 and 18.04) -* https://github.com/nnstreamer/nnstreamer/blob/main/Documentation/getting-started.md +* [getting-started](getting-started.md) - Install related packages before building nnstreamer and examples. 1. ninja-build, meson (>=0.50) diff --git a/Documentation/how-to-use-testcases.md b/Documentation/how-to-use-testcases.md index 2e6c5a9..25753ae 100644 --- a/Documentation/how-to-use-testcases.md +++ b/Documentation/how-to-use-testcases.md @@ -21,4 +21,4 @@ $ ssat ``` ## How to write Test Cases -* [How to write Test Cases](Documentation/how-to-write-testcase.md) +* [How to write Test Cases](how-to-write-testcase.md) diff --git a/Documentation/writing-tizen-native-apps.md b/Documentation/writing-tizen-native-apps.md index 66f740a..21785a8 100644 --- a/Documentation/writing-tizen-native-apps.md +++ b/Documentation/writing-tizen-native-apps.md @@ -76,11 +76,11 @@ However, with an internal API, allowed to platform binaries only (.rpm. not .tpk ## Single -A simple sample Tizen app with Single APIs is at nnstreamer-example.git, [SingleSample](https://github.com/nnstreamer/nnstreamer-example/tree/master/Tizen.native/SingleSample). +A simple sample Tizen app with Single APIs is at nnstreamer-example.git, [SingleSample](https://github.com/nnstreamer/nnstreamer-example/tree/main/Tizen.native/SingleSample). ## Pipeline -A simple sample Tizen app with Pipeline APIs is at nnstreamer-example.git, [PipelineSample](https://github.com/nnstreamer/nnstreamer-example/tree/master/Tizen.native/PipelineSample). +A simple sample Tizen app with Pipeline APIs is at nnstreamer-example.git, [PipelineSample](https://github.com/nnstreamer/nnstreamer-example/tree/main/Tizen.native/PipelineSample). # Tizen ML API Documentation diff --git a/README.md b/README.md index 6f8c2a5..52ceefd 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ In [Component Description](Documentation/component-description.md) page, we desc For more details, please access the following manuals. * For Linux-like systems such as Tizen, Debian, and Ubuntu, press [here](Documentation/getting-started.md). * For macOS systems, press [here](Documentation/getting-started-macos.md). -* To build an API library for Android, press [here](api/android/README.md). +* To build an API library for Android, press [here](Documentation/getting-started-android.md). ## Applications @@ -126,11 +126,11 @@ Although a framework may accelerate transparently as Tensorflow-GPU does, nnstre [gitter-url]: https://gitter.im/nnstreamer/Lobby -[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square +[gitter-image]: https://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square ## Contributing -Contributions are welcome! Please see our [Contributing](https://github.com/nnstreamer/nnstreamer/blob/main/Documentation/contributing.md) Guide for more details. +Contributions are welcome! Please see our [Contributing](Documentation/contributing.md) Guide for more details. [![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/0)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/0)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/1)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/1)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/2)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/2)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/3)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/3)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/4)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/4)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/5)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/5)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/6)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/6)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/images/7)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nnstreamer/links/7) diff --git a/tools/README.md b/tools/README.md index 66aab62..230944d 100644 --- a/tools/README.md +++ b/tools/README.md @@ -2,16 +2,6 @@ title: NNStreamer Tools ... -Table of Contents -================= - -* [Tools](#tools) - * [Development](#development) - * [Tracing](#tracing) - * [Debugging](#debugging) - * [Profiling](#profiling) - - # Tools ### You can find nnstreamer tools [here](https://github.com/nnstreamer/nnstreamer/tree/main/tools). This section describes how to do tracing, debugging, profiling when developers deploy NNStreamer on their own devices. @@ -24,16 +14,3 @@ There are three features as following: If you are interested in the tool technology to optimize your application using NNStremaer, please refer to the below issues. * https://github.com/nnstreamer/nnstreamer/issues/132 - - -## Development -* Press [Here](tools/development/README.md) - -## Tracing -* Press [Here](tools/tracing/README.md) - -## Debugging -* Press [Here](tools/debugging/README.md) - -## Profiling -* Press [Here](tools/profiling/README.md)