From d38b175da9cde3b66d81426a413c04f7aa60a07b Mon Sep 17 00:00:00 2001 From: PrateekJannu Date: Sun, 14 Apr 2024 23:22:56 -0400 Subject: [PATCH] finished documentation --- CONTRIBUTING.md | 6 +++--- README.md | 7 +++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28f7f75..08d3d53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -# 1. Contributing +# 1. Contributing & Developer's Guide! We welcome everyone to contribute to Solo-Synth-GAN. This document is to help you on setting up your environment, finding a task, and opening pull requests. -- [1. Contributing](#1-contributing) +- [1. Contributing \& Developer's Guide!](#1-contributing--developers-guide) - [1.1 Development setup](#11-development-setup) - [2. Contributing to Solo-Synth-GAN](#2-contributing-to-solo-synth-gan) - [2.1 Code of Conduct](#21-code-of-conduct) @@ -478,7 +478,7 @@ label from the same group. | `rejected`{ .label .rejected } | The pull request is rejected for the stated reasons. | [Solo-Synth-GAN Organization]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0 -[Solo-Synth-GAN Code of Conduct]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/CODE_OF_CONDUCT.md +[Solo-Synth-GAN Code of Conduct]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/blob/main/CONTRIBUTING.md [Solo-Synth-GAN/markdown]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0 [issue tracker]: https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/issues [syntax rules]: https://daringfireball.net/projects/markdown/syntax diff --git a/README.md b/README.md index 5723a67..0e46e30 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Solo-Synth-GAN (Zero Shot Image-2-Video) +# Solo-Synth-GAN (Zero Shot Image-2-Video) + ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PrateekJannu/Solo-Synth-GAN-v1.0/python-app.yml) ![GitHub Tag](https://img.shields.io/github/v/tag/PrateekJannu/Solo-Synth-GAN-v1.0) ![GitHub repo size](https://img.shields.io/github/repo-size/PrateekJannu/Solo-Synth-GAN-v1.0) ![GitHub Repo stars](https://img.shields.io/github/stars/PrateekJannu/Solo-Synth-GAN-v1.0) @@ -7,6 +8,8 @@ ![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white) ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) ![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) + +**[Documentation](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0)** | **[Paper(Updated Soon)]()** | **[Code of Conduct](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0?tab=coc-ov-file)** | **[Developer's Guide](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/blob/main/CONTRIBUTING.md)** ![Pyramid](Images/pyramid.jpg) @@ -186,7 +189,7 @@ By understanding the purpose and usage of each parameter, users can effectively - [ ] ...feel free to raise an issue for more environments. # 7 Contributing to Solo-Synth-GAN -The Solo-Synth-GAN project welcomes, and depends on, contributions from developers and users in the open source community. Please see the [Contributing Guide](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/CONTRIBUTING.md) for information on how you can help. +The Solo-Synth-GAN project welcomes, and depends on, contributions from developers and users in the open source community. Please see the [Contributing Guide](https://github.com/PrateekJannu/Solo-Synth-GAN-v1.0/blob/main/CONTRIBUTING.md) for information on how you can help. # 8 Additional Data(Coming Soon!)