Commit graph

63 commits

Author SHA1 Message Date
Carlos Bentzen
505291ab68 README: update gst-full-libraries to correct names
The names in the README are out-of-date since 4210ac43ec.

Also use `meson setup` rather than the implicit setup command which is
now deprecated.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7447>
2024-09-04 21:04:26 +00:00
Nirbheek Chauhan
9cc363311d meson: Add an option to disable gst-full
Not all static-library build configurations need to use this, and the
CPU time and RAM needed by gst-full targets is quite significant.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7315>
2024-08-13 01:01:28 +00:00
Edward Hervey
a3980f4838 docs: Use Discourse and Matrix as prefered communication channels
Part of: https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6220
2024-02-27 09:35:47 +01:00
ekwange
8c898b3b39 README: document updated meson requirement
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5868>
2023-12-27 09:47:00 +09:00
Stéphane Cerveau
0502897d3f readme: cleanup the static build paragraph style
Respect the 80 chars limit and cleanup the markdown format.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5011>
2023-07-11 20:18:31 +00:00
Stéphane Cerveau
e84e7df950 readme: add gstreamer-full static documentation
Add `-Dgst-full-target-type=static_library` documentation
to explain how to create a self contained GStreamer application
or library.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4893>
2023-07-10 23:40:25 +00:00
utzcoz
5c04d24553 README: Fix code formatting for meson installation command
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4721>
2023-05-26 12:29:14 +00:00
Eva Pace
0bcc141b5e README: Fix typo in test section
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4267>
2023-03-25 00:05:45 +00:00
Zhao, Gang
84212b3c34 README: Add note about updating subprojects
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3993>
2023-02-19 15:39:57 +08:00
Nirbheek Chauhan
85f2cb5770 README: Several updates to sync with status quo
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3595>
2022-12-22 17:44:32 +00:00
Xavier Claessens
949b12c7f5 README: Add section how to build and visualize documentation
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3442>
2022-12-02 15:41:32 +00:00
Nirbheek Chauhan
7a163dae4d meson: Improve certifi documentation on macOS
First, just installing certifi doesn't install the ca-cert in the
right location. The `Install Certificates.command` script also
symlinks the openssl cert.pem to the certifi ca cert file

Second, we can make it more likely that users will notice this if we
make it a warning. If we ever get a bug report about this despite
these measures, we can try to make this an error.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2707>
2022-07-18 06:25:36 +00:00
Stéphane Cerveau
1403e74196 README: update documentation for macOS
Give hints regarding the certificates
needed by Python.

urllib.error.URLError: urlopen error [SSL ..

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1794>
2022-03-23 20:47:18 +00:00
Sebastian Fricke
7063aa1471 docs: Fix typos in documentation
In building-from-source-using-meson.md:
s/implicitely/implicitly/

In README.md:
s/uncompatible/incompatible/

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00
Sebastian Fricke
5a421886b4 docs: Extend documentation for the GStreamer development environment
Add more extensive documentation for the development environment.
Document how the tool works, how to use it and common use cases.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00
Sebastian Fricke
0b6bbce012 Remove the uninstalled term
Remove the symbolic link `gst-uninstalled` which points to `gst-env`.
The `uninstalled` is the old name and the project should stick to a
single name for the procedure.
Remove the term from all the files, exceptions are variables from
dependencies like `uninstalled_variables` from pkgconfig and
`meson-uninstalled`.
Adjust mentions of the script in the documentation and README.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1743>
2022-03-01 11:33:10 +00:00
Seungha Yang
7c3ce9c70d README: Remove outdated Windows ARM64 related comment
We bumped required meson version which contains the mentioned
meson patch already.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1221>
2021-10-21 12:53:17 +00:00
Brad Hards
f0de5a39c1 doc: update meson version in README.md
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1209>
2021-10-20 13:22:25 +00:00
Tim-Philipp Müller
d4bdbeaa0d meson: add 'gpl' option and only build plugins with (A)GPL deps if explicitly enabled
Require explicit opt-in to build plugins with (A)GPL dependencies.

Keep ugly/bad options on 'auto' for now so cerbero doesn't fail.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1084>
2021-10-18 18:03:19 +01:00
Stéphane Cerveau
d435b154b8 core: remove outdated mention to gst-build
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/956>
2021-09-30 12:24:38 +00:00
Brad Hards
ef05946837 doc: update IRC links to OFTC
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/945>
2021-09-28 10:11:15 +10:00
Thibault Saunier
f33e6655a3 Update README.md now that all modules have been merged in gstreamer
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/891>
2021-09-24 16:21:18 -03:00
Stéphane Cerveau
b6f61768d3 gst-full: add 'gst-full-' features options
These options allow to select a set of features from a given
plugin with the following syntax:

-Dgst-full-plugins=plugin1;plugin10
-Dgst-full-elements=plugin2:element1,element2
-Dgst-full-typefind-functions=plugins3:func
-Dgst-full-device-providers=plugin4,dp1
-Dgst-full-dynamic-types=plugin5:dt1

By default all the enabled plugin are registered and
gst-full-plugins will allow to include only a set of plugin

If a feature(element, typefind etc.) is selected from a plugin,
the plugin is removed from the plugins list.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/199>
2020-12-11 12:50:16 +00:00
Stéphane Cerveau
d5dcbdb51b gst-full: use a default version script
Use a default version script instead of
Bsymbolic to get rid of x264 and ffmpeg
symbol relocation issue.

https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/108

Export only glib and gstreamer symbols.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/204>
2020-10-14 16:05:13 +02:00
Guillaume Desmottes
89faf739c9 meson: add gst-full-version-script option
Can be used to control the exact symbols exported, or not, in
libgstreamer-full.

This is useful when building a tailored libgstreamer-full aimed
to be run with some specific binaries. By using such version script
one can reduce the size of the generated lib by letting the linker
garbage collect all the unused APIs.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/195>
2020-10-06 12:54:19 +00:00
Xavier Claessens
d4f95054e1 README: Document gstreamer-full-1.0
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/191>
2020-10-05 17:17:46 -04:00
Seungha Yang
64029b1461 README: Document ARM64 native build on Windows
Add some guide for native ARM64 build on Windows

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/175>
2020-07-15 22:12:28 +09:00
Tim-Philipp Müller
d47dddb78c README: document updated meson requirement 2020-06-18 16:42:33 +01:00
Nirbheek Chauhan
9782400920 README: Add a screenshot showing how to run meson on windows
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-build/-/merge_requests/161>
2020-06-15 21:01:01 +05:30
Nirbheek Chauhan
3e1c57553e README: Document which dependencies are available
Also document how to build the Intel MSDK plugins, and how to
enable/disable plugins in general.

Closes https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/90
2020-04-16 18:58:06 +05:30
Nirbheek Chauhan
d6fdd8afc6 README: Document gst-worktree, remove checkout-branch-worktree
Closes https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/72
2020-04-16 18:54:26 +05:30
Nirbheek Chauhan
88f5262ba3 README: Use 'builddir' instead of 'build/'
`/` was added to make it clear that `build` is a directory and not
a meson sub-command. However, this can be confusing for Windows users.
use `builddir` which does the same job.
2020-04-16 18:47:03 +05:30
Charlie Turner
c57dca5220 dev environment: allow printing only env without starting a shell
allow for workflows that don't want the gst scripts to start shells,
this can be awkward for higher-level scripts setting up shells
themselves.

this is especially useful in combination with eval, and mimics the sort
of thing you can do with ssh-agent -s.
2020-01-06 21:06:42 +00:00
Nirbheek Chauhan
b46aa21ed4 gst-env: Automatically set the prompt for zsh too 2019-12-22 20:16:25 +05:30
Philippe Normand
7cbd30eb65 README: Remove now-useless Fish prompt setup docs
After commit e13e6758e3 there's no need to
manually configure the prompt.
2019-12-20 19:34:05 +01:00
Stéphane Cerveau
c9a52c7939 dev environment: update documentation
Add gst-dev.py usage with an external script.
2019-11-25 20:40:05 +00:00
Thibault Saunier
3d8662ebfe Add support for wine+mingw environments 2019-10-01 09:20:25 -03:00
Thibault Saunier
fe39bd3027 Rename 'uninstalled' to development environment
In the case of wine, the env can not be uninstalled, also developers
do not necessiraly care about the fact that it is "uninstalled", the
important thing is that it is a development environment, meaning
that they can work on GStreamer or with GStreamer in the environment.

I still keep the `uninstalled` target to avoid changing people's
habits for now.
2019-09-24 08:23:07 -03:00
Thibault Saunier
7fb7739337 Fix link to meson "subprojects" documentation 2019-04-25 17:29:19 +00:00
Tim-Philipp Müller
f21a06f5d2 README: minor clarification
Fixes .
2019-04-25 17:21:02 +01:00
Nirbheek Chauhan
57e876e339 README: Add instructions for Windows with screenshots
Also add a note about installation
2019-04-17 17:55:48 +05:30
Nirbheek Chauhan
acf83f17c2 README.md: Document how to build the qt5 plugin 2019-04-02 13:16:05 +00:00
Tim-Philipp Müller
b0eea913a4 README: small updates 2019-03-29 13:24:10 +00:00
Antonio Ospite
8af2376bc0 gst-uninstalled: make the bash prompt override optional
When using a custom prompt the automatic override may not look good, so
provide a mechanism to disable it.

Document that the user will have to use GST_ENV manually when setting
the prompt to have a visual indicator of the gst-uninstalled
environment.
2019-03-17 21:08:08 +01:00
Nirbheek Chauhan
0c4456fb13 README: Warn about not using the Meson MSI 2018-10-28 16:05:49 +00:00
Thibault Saunier
8f5533c1e1 Add a script to checkout a worktree of gst-build and its subprojects
https://bugzilla.gnome.org/show_bug.cgi?id=794519
2018-03-20 09:22:19 -03:00
Guillaume Desmottes
bff7689565 README.md: explain how to run a specific test from a specific file
https://bugzilla.gnome.org/show_bug.cgi?id=793190
2018-02-05 16:51:25 +01:00
Guillaume Desmottes
54f73bc847 README.md: update specific test example
Tests naming scheme has changed.

https://bugzilla.gnome.org/show_bug.cgi?id=793190
2018-02-05 16:51:25 +01:00
Guillaume Desmottes
eb6e846023 README.md: use 'meson test' instead of 'mesontest'
The latter has been deprecated.

https://bugzilla.gnome.org/show_bug.cgi?id=793190
2018-02-05 16:51:25 +01:00
Philippe Normand
c23be22adc README: Document fish shell prompt customization 2017-12-01 14:16:34 +00:00