Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep README and Changelog for v0.1.0 #27

Open
bhoov opened this issue Oct 25, 2024 · 7 comments
Open

Prep README and Changelog for v0.1.0 #27

bhoov opened this issue Oct 25, 2024 · 7 comments
Assignees
Labels

Comments

@bhoov
Copy link
Collaborator

bhoov commented Oct 25, 2024

The README should include

  • "Sales pitch" for this extension
  • Summary of core supported features
  • Example usage accompanied by a demo video
  • (as reference) Manim Notebook commands alongside their default shortcut
  • Roadmap of features for the near future

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.

@bhoov bhoov added the v0.1.0 label Oct 25, 2024
@bhoov bhoov self-assigned this Oct 25, 2024
@VladimirFokow
Copy link
Collaborator

VladimirFokow commented Oct 25, 2024

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
Copy link
Collaborator

VladimirFokow commented Oct 25, 2024

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
Copy link
Collaborator Author

bhoov commented Oct 27, 2024

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
Copy link
Member

Splines commented Oct 27, 2024

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
Copy link
Member

Splines commented Oct 28, 2024

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
Copy link
Member

Splines commented Oct 30, 2024

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.

@Splines
Copy link
Member

Splines commented Dec 5, 2024

Also make clear which minimal ManimGL version we support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants