New readme #597

mat-hek · 2023-09-15T09:36:14Z

Todo:

add a GH action for generating the packages list

FelonEkonom · 2023-09-19T09:38:48Z

update_packages_list.exs

+    Process.sleep(gh_req_timeout)
+
+    Req.get!(
+      "https://api.github.com/orgs/#{org}/repos?per_page=100",


Why per_page=100? IMO it would be safer to put here bigger number

That's the maximum that github allows :/ if we want more, we need to paginate, I'll see how hard it is

FelonEkonom · 2023-09-19T09:39:49Z

update_packages_list.exs

+# find repos from the membraneframework organization that aren't in the list
+
+package_names =
+  packages |> Enum.filter(&(&1.type == :package)) |> Enum.map(& &1.name) |> MapSet.new()


use https://hexdocs.pm/elixir/1.15/MapSet.html#new/2

FelonEkonom · 2023-09-19T10:01:16Z

update_packages_list.exs

+lacking_repos =
+  repos
+  |> Map.values()
+  |> Enum.filter(&(&1.owner.login == "membraneframework"))


What is the reason of this Enum.filter? What values, different than "membraneframework", may occur in this place?

This is the organisation, it can be membraneframework-labs, jellyfish-dev or some third party. This is needed to print a warn whenever a repo from membraneframework is not in the list

FelonEkonom · 2023-09-19T10:05:04Z

update_packages_list.exs

+        end
+
+      hex = Req.get!("https://hex.pm/api/packages/#{name}", decode_json: [keys: :atoms])
+      hex_present = hex.status == 200


Suggested change

hex_present = hex.status == 200

hex_present? = hex.status == 200

FelonEkonom · 2023-09-19T10:09:24Z

update_packages_list.exs

+
+packages_md =
+  packages
+  |> Enum.map_reduce(%{header_present: false}, fn


Suggested change

|> Enum.map_reduce(%{header_present: false}, fn

|> Enum.map_reduce(%{header_present?: false}, fn

FelonEkonom · 2023-09-19T11:43:28Z

README.md

+This is an [Elixir](elixir-lang.org) snippet, that streams an mp3 via HTTP and plays it on your speaker. Here's how to run it:
+- Install [libmad](https://github.com/markjeee/libmad) and [portaudio](https://github.com/PortAudio/portaudio). Membrane uses these libs to decode the mp3 and to access your speaker, respectively. You can use these commands:
+  - On Mac OS: `brew install libmad portaudio pkg-config`
+  - On Debian: `apt install libmad0-dev portaudio19-dev`


I guess, that since introducing precompiled dependencies in Bundlex, it won't be needed - as far as I know, it should be merged soon

Yeah, I'll remove that once we merge it and the required libraries support it

FelonEkonom · 2023-09-19T11:45:26Z

README.md

+
+## Learning
+
+The best place to learn Membrane is the [membrane.stream/learn](https://membrane.stream/learn) website and the [membrane_demo](https://github.com/membraneframework/membrane_demo) repository. Try them out, then hack something exciting!


Don't we want to have guide/tutorials here?

Guide is being moved to tutorials, and tutorials are deployed to membrane.stream/learn

FelonEkonom · 2023-09-19T11:52:21Z

README.md

+The most basic media processing entities of Membrane are `Element`s. An element might be able, for example, to mux incoming audio and video streams into MP4, or play raw audio using your sound card. You can create elements yourself, or choose from the ones provided by the framework.
+
+Elements can be organized into a pipeline - a sequence of linked elements that perform a specific task. For example, a pipeline might receive an incoming RTSP stream from a webcam and convert it to an HLS stream, or act as a selective forwarding unit (SFU) to implement your own videoconferencing room. The [Quick start](#quick-start) section above shows how to create a simple pipeline.
+
+### Membrane packages
+
+To embrace modularity, Membrane is delivered to you in multiple packages, including plugins, formats, core and standalone libraries. The complete list of all the Membrane packages maintained by the Membrane team is available [here](https://github.com/membraneframework/membrane_core/Membrane-packages).
+
+**Plugins**
+
+Plugins provide elements that you can use in your pipeline. Each plugin lives in a `membrane_X_plugin` repository, where X can be a protocol, codec, container or functionality, for example [mebrane_opus_plugin](https://github.com/membraneframework/membrane_opus_plugin). Plugins wrapping a tool or library are named `membrane_X_LIBRARYNAME_plugin` or just `membrane_LIBRARYNAME_plugin`, like [membrane_mp3_mad_plugin](https://github.com/membraneframework/membrane_mp3_mad_plugin). Plugins are published on [hex.pm](https://hex.pm), for example [hex.pm/packages/membrane_opus_plugin](https://hex.pm/pakcages/membrane_opus_plugin) and docs are at [hexdocs](https://hexdocs.pm), like [hexdocs.pm/membrane_opus_plugin](https://hexdocs.pm/membrane_opus_plugin). Some plugins require native libraries installed in your OS. Those requirements, along with usage examples are outlined in each plugin's readme.


WDYT about changing Element on Component here? I understand, that introducing concept of bin might make this section unnecessary complicated, but using word Component instead of Element won't cause that

I thought about it, but it would require explaining what components are, so we'd have to mention bins anyway. I'd rather avoid using any Membrane-specific term without describing what it means. It makes me wonder if defining the bin as a special type of element would be better, as it would be easier to explain step by step.

README.md

FelonEkonom · 2023-09-19T11:56:56Z

README.md

+- Create learning materials. We try our best but can cover only a limited number of Membrane use cases.
+- Improve docs. We know it's not the most exciting part, but if you had a hard time understanding the docs, you're the best person to fix them ;)
+- Contribute code - plugins, features and bug fixes. It's best to contact us before, so we can provide our help & assistance, and agree on important matters. For details see the [contribution guide](CONTRIBUTING.md)


Add dot at the end of the last line or remove it from the end of the line with Create learning materials ...

FelonEkonom · 2023-09-21T15:08:16Z

README.md

+### []() Let's meet on 13th October at [RTC.ON](https://rtcon.live) - the first conference about Membrane & multimedia!
+### []() Learn more at [rtcon.live](https://rtcon.live)


[]() <- Is this intetional?

Yes, github sometimes behaves weirdly if there's a link in a header. Adding an empty link at the beginning seems to fix it.

FelonEkonom · 2023-09-26T09:44:45Z

.github/workflows/update-packages-list.yml

+          elixir update_packages_list.exs
+          git config user.name 'Membrane Bot'
+          git config user.email 'bot@membrane.stream'
+          git checkout -b auto-update-packages-list


This line will fail, if branch auto-update-packages-list already exists

FelonEkonom · 2023-09-26T09:45:14Z

.github/workflows/update-packages-list.yml

+          git config user.email 'bot@membrane.stream'
+          git checkout -b auto-update-packages-list
+          git add README.md
+          git commit -m"auto update packages list in readme" --allow-empty


Suggested change

git commit -m"auto update packages list in readme" --allow-empty

git commit -m "auto update packages list in readme" --allow-empty

FelonEkonom · 2023-09-26T09:48:03Z

update_packages_list.exs

+  ~r/<!-- packages-list-start -->(.|\n)*<!-- packages-list-end -->/m,
+  packages_md
+)
+|> then(&File.write(readme_path, &1))


Suggested change

|> then(&File.write(readme_path, &1))

|> then(&File.write!(readme_path, &1))

Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>

mat-hek added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label Sep 15, 2023

mat-hek force-pushed the readme branch 3 times, most recently from 47fae5d to 6321989 Compare September 15, 2023 09:38

mat-hek marked this pull request as ready for review September 15, 2023 11:49

mat-hek requested review from varsill and FelonEkonom September 15, 2023 11:50

mat-hek changed the title ~~Readme~~ New readme Sep 15, 2023

FelonEkonom requested changes Sep 19, 2023

View reviewed changes

mat-hek force-pushed the readme branch from 908fb05 to 3980839 Compare September 21, 2023 10:33

mat-hek requested a review from FelonEkonom September 21, 2023 10:33

FelonEkonom reviewed Sep 21, 2023

View reviewed changes

mat-hek requested a review from FelonEkonom September 22, 2023 15:11

FelonEkonom approved these changes Sep 25, 2023

View reviewed changes

mat-hek requested a review from FelonEkonom September 25, 2023 15:12

FelonEkonom reviewed Sep 26, 2023

View reviewed changes

mat-hek requested a review from FelonEkonom September 26, 2023 10:34

FelonEkonom approved these changes Sep 26, 2023

View reviewed changes

mat-hek and others added 12 commits September 26, 2023 15:42

new readme

4483a68

add packages list

188159a

update example

0406fee

add package list generator

c53d973

update readme and example to match the guide

76c600d

fix readme urls

539c1f6

update packages list

3e70505

fix readme

5a9d3de

format example

97a1da7

Update README.md

7aecbdd

Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>

fixes for CR

93aabd5

add update packages list action

5a75f48

fixes for CR

69878b7

mat-hek force-pushed the readme branch from 676f6f9 to 69878b7 Compare September 26, 2023 13:43

mat-hek merged commit 53598cc into master Sep 26, 2023
7 checks passed

mat-hek deleted the readme branch September 26, 2023 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New readme #597

New readme #597

mat-hek commented Sep 15, 2023 •

edited

FelonEkonom Sep 19, 2023

mat-hek Sep 19, 2023 •

edited

FelonEkonom Sep 19, 2023

FelonEkonom Sep 19, 2023

mat-hek Sep 19, 2023

FelonEkonom Sep 19, 2023

FelonEkonom Sep 19, 2023

FelonEkonom Sep 19, 2023

mat-hek Sep 19, 2023

FelonEkonom Sep 19, 2023

mat-hek Sep 19, 2023

FelonEkonom Sep 19, 2023

mat-hek Sep 20, 2023 •

edited

FelonEkonom Sep 19, 2023

FelonEkonom Sep 21, 2023 •

edited

mat-hek Sep 22, 2023

FelonEkonom Sep 26, 2023

FelonEkonom Sep 26, 2023

FelonEkonom Sep 26, 2023

	hex_present = hex.status == 200
	hex_present? = hex.status == 200

	\|> Enum.map_reduce(%{header_present: false}, fn
	\|> Enum.map_reduce(%{header_present?: false}, fn


		## Learning

		The best place to learn Membrane is the [membrane.stream/learn](https://membrane.stream/learn) website and the [membrane_demo](https://github.com/membraneframework/membrane_demo) repository. Try them out, then hack something exciting!

		### []() Let's meet on 13th October at [RTC.ON](https://rtcon.live) - the first conference about Membrane & multimedia!
		### []() Learn more at [rtcon.live](https://rtcon.live)

	git commit -m"auto update packages list in readme" --allow-empty
	git commit -m "auto update packages list in readme" --allow-empty

	\|> then(&File.write(readme_path, &1))
	\|> then(&File.write!(readme_path, &1))

New readme #597

New readme #597

Conversation

mat-hek commented Sep 15, 2023 • edited

Choose a reason for hiding this comment

mat-hek Sep 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mat-hek Sep 20, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FelonEkonom Sep 21, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mat-hek commented Sep 15, 2023 •

edited

mat-hek Sep 19, 2023 •

edited

mat-hek Sep 20, 2023 •

edited

FelonEkonom Sep 21, 2023 •

edited