Deprecated CLI flag is advertised on our github front page

[cobordism]

The main picture on our github landing page is

manim file.py Scene -pl

We should change it to manim myFile.py myScene -p -ql ... or even manimce if that is what we decide on as an entrypoint.

[leotrs]

Adding this to #148

[eulertour]

How was that picture even created?

[leotrs]

This has been there since The Beginning.

[cobordism]

shall we make one with manim?

https://discord.com/channels/581738731934056449/581738732646957057/765182589807624192

[eulertour]

Yeah, that'd be perfect

[cobordism]

class cliExample(Scene):
    def construct(self):
        def myTex(*args, **kwargs):
            return Tex(
                *args,
                tex_template=TexFontTemplates.latin_modern_tw,
                background_stroke_width=0,
                **kwargs
            )

        cmd = myTex(
            r"\textbf{manim}",
            r"\textbf{  myfile.py}",
            r"\textbf{  MyScene}",
            r"\textbf{  -ql -p}",
        ).shift(1.5 * UP)
        cmd.set_color_by_tex("manim", "#AA0000")
        cmd.set_color_by_tex("file", "#0000AA")
        cmd.set_color_by_tex("Scene", PURPLE)
        cmd.set_color_by_tex("ql", GREEN)

        e1 = (
            myTex(r"The manim\\command", color=BLACK, tex_environment=None)
            .scale(0.4)
            .align_to(cmd[0], LEFT, alignment_vect=LEFT)
            .set_y(cmd[1].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e2 = (
            myTex(r"File containing\\your animation", color=BLACK, tex_environment=None)
            .scale(0.4)
            .align_to(cmd[1], LEFT, alignment_vect=LEFT)
            .set_y(cmd[1].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e3 = (
            myTex(
                r"(Optional) \\Name of the\\ scene to render",
                color=BLACK,
                tex_environment=None,
            )
            .scale(0.4)
            .align_to(cmd[2], LEFT, alignment_vect=LEFT)
            .set_y(cmd[2].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e4 = (
            myTex(
                r"(Optional) \\Render in \\low quality,\\ autoplay when\\ done rendering",
                color=BLACK,
                tex_environment=None,
            )
            .scale(0.4)
            .align_to(cmd[3], LEFT, alignment_vect=LEFT)
            .set_y(cmd[3].get_y(direction=DOWN) - 0.15, direction=UP)
        )

        self.add(cmd, e1, e2, e3, e4)
        self.wait(1)

^^ UPDATED SCRIPT ^^

[safinsingh]

How was that picture even created?

@eulertour in case you were still curious, I made that with Google Drawings 😆

[kolibril13]

Two things to note here: myscene should not have the .py ending and further, it should be CamelCase.
I updated the script:

class cliExample(Scene):
    def construct(self):
        def myTex(*args, **kwargs):
            return Tex(
                *args,
                tex_template=TexFontTemplates.latin_modern_tw,
                background_stroke_width=0,
                **kwargs
            )

        cmd = myTex(
            r"\textbf{manim}",
            r"\textbf{  myfile.py}",
            r"\textbf{  MyScene}",
            r"\textbf{  -ql -p}",
        ).shift(1.5 * UP)
        cmd.set_color_by_tex("manim", "#AA0000")
        cmd.set_color_by_tex("file", DARK_BLUE)
        cmd.set_color_by_tex("MyScene", PURPLE)
        cmd.set_color_by_tex("ql", GREEN)

        e1 = (
            myTex(r"The manim\\command", color=BLACK, tex_environment=None)
                .scale(0.4)
                .align_to(cmd[0], LEFT, alignment_vect=LEFT)
                .set_y(cmd[1].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e2 = (
            myTex(r"File containing\\your animation", color=BLACK, tex_environment=None)
                .scale(0.4)
                .align_to(cmd[1], LEFT, alignment_vect=LEFT)
                .set_y(cmd[1].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e3 = (
            myTex(
                r"(Optional) \\Name of the\\ scene to render",
                color=BLACK,
                tex_environment=None,
            )
                .scale(0.4)
                .align_to(cmd[2], LEFT, alignment_vect=LEFT)
                .set_y(cmd[2].get_y(direction=DOWN) - 0.15, direction=UP)
        )
        e4 = (
            myTex(
                r"(Optional) \\Render in \\low quality,\\ autoplay when\\ done rendering",
                color=BLACK,
                tex_environment=None,
            )
                .scale(0.4)
                .align_to(cmd[3], LEFT, alignment_vect=LEFT)
                .set_y(cmd[3].get_y(direction=DOWN) - 0.15, direction=UP)
        )

        self.add(cmd, e1, e2, e3, e4)
        self.wait(1)

[cobordism]

[jsonvillanueva]

It's worth note, you can combine the options -ql and -p into -pql

[leotrs]

@jsonvillanueva yes, but separating them is better for explanation

[cobordism]

Shall we update the image to include the subcommand "render"?

Context: since release 0.5.0 the command manim render is / can be used to render video output.