search

Manim-Notebook / manim-notebook

Simple commands to replicate the manim dev workflow in VSCode
MIT License
5 stars 0 forks source link

Prep README and Changelog for v0.1.0 #27

Open bhoov opened 1 week ago

bhoov commented 1 week ago

The README should include

The Changelog should view v0.1.0 as the "initial release" and list all features that are supported. In a sense, it is the first release under a formal github workflow and the first that is publicly announced.

VladimirFokow commented 1 week ago

also, for "example usage" - it would be nice to at least link to this:
https://github.com/3b1b/manim/blob/1139b545f9e766e7282f8cf64e68e225a4f25eb1/manimlib/scene/interactive_scene.py#L469-L539

("manim-window shortcuts" - an essential part for many use-cases)

VladimirFokow commented 1 week ago

thoughts, where we can also announce it:

discord, reddit which are linked here: https://github.com/3b1b/manim?tab=readme-ov-file

but only when the major issues are solved

bhoov commented 6 days ago

So we would announce on:

  1. Reddit
  2. Discord to which channel(s)? I see #general, #projects, #beginner-resources, #tips-and-tricks as all valid. Perhaps we can spam multiple channels 😇
  3. Twitter (tag @3blue1brown and @manim_community)
  4. LinkedIn (maybe?)
  5. As a comment on Grant's how-to youtube video

Any other outlets you would consider? @Splines @VladimirFokow what are your twitter handles?

Splines commented 5 days ago

I don't have a Twitter account, but I might post a video on my YouTube channel. However, I'd like such a video to be more than a sales-pitch and to go a bit more in-depth, so this won't happen in the timeframe you have envisioned and I'm not sure if I even have time for that video ;)

I can however create a YouTube post on my channel with a square image advertising the new extension. And on LinkedIn as well. It'd be really nice if you could create such an asset for us to use, e.g. with the VSCode icon in a corner, your cool extension logo in the center and a short title (in the image).

As a further idea: let's file in a PR to 3b1b's manim repo or to his video repo where we add a link to the extension in the Readme.

Splines commented 5 days ago

I think we should also include some images in the Readme. Since to be honest: when installing a new extension, I rarely take a too close look on the Readme. I just scroll through it and if images stand out I will see them first. Users should at least remark the ## notation in our Readme, so maybe we can showcase that in an image (including alt attributes for screen-readers).

Splines commented 2 days ago

I've just seen that on the VSCode Discussions, there exists an Extension Show and Tell category where we could also post upon our first bigger release.