From b15123383bee6dbaaf65c2470e0abb61b6f7f651 Mon Sep 17 00:00:00 2001 From: hkonsti <45428767+hkonsti@users.noreply.github.com> Date: Tue, 12 Mar 2024 11:46:50 +0100 Subject: [PATCH 1/3] docs: update --- CONTRIBUTING.md | 130 ------------------------------------------------ FUNDING.yml | 4 -- README.md | 37 ++++++++------ SECURITY.md | 9 ++-- 4 files changed, 27 insertions(+), 153 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 FUNDING.yml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index bb32d943..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,130 +0,0 @@ -# Contributing to Motion Canvas - -This is an initial version of the Contribution Guide. Feel free to discuss it -and suggest any changes on [our discord server][discord]. - -## Code of Conduct - -Before contributing to the project, please read our -[Code of Conduct](./CODE_OF_CONDUCT.md). - -## Reporting a bug - -Before you submit an issue, please search [the issue tracker][issues]. An issue -for your problem might already exist and the discussion might inform you of -workarounds readily available. - -You can file new issues by [selecting an issue template][new-issue] and filling -out the necessary information. - -## Proposing a Change - -If you intend to change the public API, make any non-trivial changes to the -implementation, or create brand-new guides in the documentation, make sure to -[create an issue][new-feature] first. This will let us discuss a proposal before -you put significant effort into it. After a proposal has been discussed it may -receive the [`c-accepted`][label-accepted] label indicating that it's ready to -be implemented. - -If you're only fixing a bug or a typo, it's fine to submit a pull request right -away without creating an issue, but make sure it contains a clear and concise -description of the bug. - -## Working on Issues - -Before you start working on an issue make sure that it has been accepted -(indicated by a [`c-accepted`][label-accepted] label) and that no one has -claimed it yet. Otherwise, you may duplicate other people's efforts. If somebody -claims an issue but doesn't follow up for more than two weeks, it’s fine to take -it over, but you should still leave a comment. You should also leave a comment -on any issue you're working on, to let others know. - -## Semantic Versioning - -Motion Canvas follows [semantic versioning][semver]. - -## Making a Pull Request - -1. Fork the revideo/revideo repo. -2. In your forked repo, create a new branch for your changes: - ```shell - git checkout -b my-fix-branch main - ``` -3. Update the code. -4. Commit your changes using a **descriptive commit message** that follows the - [Angular Commit Message Conventions][commit-format]. We strongly discourage - using AI to generate commit descriptions. If you believe the description is - not worth writing then it's probably not necessary. - ```shell - git commit --all - ``` - When committing the changes, our git hooks should automatically run Prettier - and ESLint for you. If, for some reason, hooks are not supported in your - working environement, you can run these tools using `npm run prettier:fix` - and `npm run eslint:fix` respectively. -5. Push your branch to GitHub: - ```shell - git push origin my-fix-branch - ``` -6. In GitHub, send a pull request to [the main branch][main] and **request a - review** from [aarthificial](https://github.com/aarthificial). - -### Going through verification - -After you made a pull request, a GitHub workflow will be dispatched to verify -it. There are a few checks that can fail: - -| Check name | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Prepare` | Something bad happened when preparing your pull request for verification. This is most likely a problem with our pipeline so make sure to notify us about it. | -| `Commit message` | The commit message doesn't follow the [Angular Commit Message Conventions][commit-format]. You can ignore this check since maintainers can modify your commit message before merging, but make sure to follow the conventions in the future. | -| `Lint` | ESLint has failed. Run `npm run eslint` locally to list the problems. | -| `Code style` | The code is not correctly formatted. Run `npm run prettier:fix` locally to fix the formatting issues. | -| `Build` | The build process failed. Run `npx lerna run build` locally to see the errors. | -| `Unit tests` | Unit tests failed. Run `npx lerna run test` locally to see the which tests are failing and fix them. | -| `Examples` | The examples failed to build. Run `npm run examples:build` locally to see the errors. | -| `E2E` | End-to-end tests failed to build. Run `npm run examples:build` locally to see the errors. | -| `Documentation` | The documentation website failed to build. Run `npm run docs:build` locally to see the errors. | - -### Addressing review feedback - -1. Make required updates to the code. -2. Create a fixup commit and push it to your GitHub repo: - ```shell - git commit --all --fixup HEAD - git push - ``` - -## Using generative AI - -Using generative AI to help you write code and documentation is allowed, but use -it to enhance your work, not replace it. Pull requests that are a mindless copy -of the output of an AI model will be rejected. - -## Getting the _Contributor_ Discord role - -After one of your pull requests has been merged, you can receive the -_Contributor_ role on [our discord server][discord]. To do that, create a -[secret gist][gist] on GitHub and DM one of the server moderators with the link. -This will let us verify that you're the author of the pull request. - -## Attribution - -This Contribution Guide was partially inspired by [React][react] and -[Angular][angular]. - -[semver]: https://semver.org/ -[discord]: https://chat.motioncanvas.io -[semantic-release]: - https://semantic-release.gitbook.io/semantic-release/support/faq#can-i-set-the-initial-release-version-of-my-package-to-0.0.1 -[main]: https://github.com/revideo/revideo/tree/main -[issues]: https://github.com/revideo/revideo/issues -[new-issue]: https://github.com/revideo/revideo/issues/new/choose -[new-feature]: - https://github.com/revideo/revideo/issues/new?template=feature_request.md -[commit-format]: - https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit -[angular]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md -[react]: https://reactjs.org/docs/how-to-contribute.html -[label-accepted]: https://github.com/revideo/revideo/labels/c-accepted -[gist]: https://gist.github.com/ diff --git a/FUNDING.yml b/FUNDING.yml deleted file mode 100644 index c7c20b14..00000000 --- a/FUNDING.yml +++ /dev/null @@ -1,4 +0,0 @@ -# These are supported funding model platforms - -github: [aarthificial] -patreon: aarthificial diff --git a/README.md b/README.md index b61d0907..a2595412 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,29 @@


-# Motion Canvas +# ReVideo - Make videos with AI -Motion Canvas is two things: +Revideo is -- A TypeScript library that uses generators to program animations. -- An editor providing a real-time preview of said animations. +- A typescript library to generate videos using AI +- A collection of API wrappers for services used in generated videos (e.g. + text-to-speech and text-to-image, see full list below) +- An editor to provide instant previews of generated videos +- Forked from the amazing Motion Canvas -It's a specialized tool designed to create informative vector animations and -synchronize them with voice-overs. +Think of LangChain, but for video -Aside from providing the preview, the editor allows you to edit certain aspects -of the animation which could otherwise be tedious. +## Using ReVideo -## Using Motion Canvas +Check out our [getting started][docs] guide to learn how to use Revideo. -Check out our [getting started][docs] guide to learn how to use Motion Canvas. +## APIs currently supported -## Developing Motion Canvas locally +- [ ] Elevenlabs +- [ ] Dall-E +- [ ] Stable Diffusion + +## Developing Revideo locally The project is maintained as one monorepo containing the following packages: @@ -71,11 +76,11 @@ Canvas project that can be used during development. To develop the player, first build the template: `npm run template:build`. Then, start `npm run player:dev`. -## Installing a local version of Motion Canvas in a project +## Installing a local version of Revideo in a project -It can be useful to install a local version of Motion Canvas in a standalone -project. For example, when you want to use your own fork with some custom-made -features to create your animations. +It can be useful to install a local version of Revideo in a standalone project. +For example, when you want to use your own fork with some custom-made features +to create your animations. Let's assume the following project structure: @@ -127,7 +132,7 @@ You can use the same technique to test out any custom package you're working on. ## Contributing Read through our [Contribution Guide](./CONTRIBUTING.md) to learn how you can -help make Motion Canvas better. +help make Revideo better. [authenticate]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token diff --git a/SECURITY.md b/SECURITY.md index e19177f4..2a59a4b1 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,15 +2,18 @@ ## Supported Versions -Motion Canvas does not provide a long-term security support for any of its older +Revideo does not provide a long-term security support for any of its older versions. Only the newest release is being supported with security updates. ## Reporting a Vulnerability **Please do not report security vulnerabilities through public GitHub issues.** -Instead, please kindly email us at -[aarthificial+revideo@gmail.com](mailto:aarthificial+revideo@gmail.com) +Instead, please kindly email us at [hello@haven.run](mailto:hello@haven.run) + +We are a fork of Motion Canvas, so should you find a security vulnerability that +affects both projects, please also contact them at +[aarthificial+motion-canvas@gmail.com](mailto:aarthificial+motion-canvas@gmail.com) After receiving a report, we will try to confirm the problem. You should receive a response within 48 hours, informing you about our plans concerning the From 9a1653e424be7f813caa22b8ef9d387ed199e9c3 Mon Sep 17 00:00:00 2001 From: hkonsti <45428767+hkonsti@users.noreply.github.com> Date: Mon, 18 Mar 2024 17:47:44 +0100 Subject: [PATCH 2/3] docs: change logo --- README.md | 16 +++++----------- logo.svg | 6 ++++++ logo_dark.svg | 6 ++++++ 3 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 logo.svg create mode 100644 logo_dark.svg diff --git a/README.md b/README.md index a2595412..b9039ea4 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@

- + - - Motion Canvas logo + + Revideo logo

published with lerna powered by vite - npm package version - discord + npm package version + discord


@@ -31,12 +31,6 @@ Think of LangChain, but for video Check out our [getting started][docs] guide to learn how to use Revideo. -## APIs currently supported - -- [ ] Elevenlabs -- [ ] Dall-E -- [ ] Stable Diffusion - ## Developing Revideo locally The project is maintained as one monorepo containing the following packages: diff --git a/logo.svg b/logo.svg new file mode 100644 index 00000000..70db63df --- /dev/null +++ b/logo.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/logo_dark.svg b/logo_dark.svg new file mode 100644 index 00000000..0638dfea --- /dev/null +++ b/logo_dark.svg @@ -0,0 +1,6 @@ + + + + + + From d520f2bc0633ef1bbf6a7e5f7c26ce8f80ab230e Mon Sep 17 00:00:00 2001 From: hkonsti <45428767+hkonsti@users.noreply.github.com> Date: Tue, 19 Mar 2024 09:45:19 +0100 Subject: [PATCH 3/3] docs: update readme --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b9039ea4..e7fb574b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@


-# ReVideo - Make videos with AI +# Revideo - Make videos with AI Revideo is @@ -27,7 +27,7 @@ Revideo is Think of LangChain, but for video -## Using ReVideo +## Using Revideo Check out our [getting started][docs] guide to learn how to use Revideo. @@ -80,7 +80,7 @@ Let's assume the following project structure: ``` projects/ -├── motion-canvas/ <- your local monorepo +├── revideo/ <- your local monorepo └── my-project/ <- a bootstrapped project └── package.json ``` @@ -91,8 +91,8 @@ relative path to the package you want to link: ```diff "dependencies": { -- "@motion-canvas/core": "^3.11.0", -+ "@motion-canvas/core": "file:../motion-canvas/packages/core", +- "@revideo/core": "^3.11.0", ++ "@revideo/core": "file:../revideo/packages/core", // ... }, ``` @@ -102,7 +102,7 @@ to allow vite to load external files: ```ts import {defineConfig} from 'vite'; -import motionCanvas from '@motion-canvas/vite-plugin'; +import motionCanvas from '@revideo/vite-plugin'; export default defineConfig({ server: { @@ -131,5 +131,5 @@ help make Revideo better. [authenticate]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token [template]: https://github.com/motion-canvas/project-template#using-the-template -[discord]: https://chat.motioncanvas.io +[discord]: https://discord.com/invite/JDjbfp6q2G [docs]: https://motioncanvas.io/docs/quickstart