Skip to content

Commit 51278c7

Browse files
committed
add brief contribution instructions in lieu of full code-of-conduct and contribution guidelines
1 parent 2e299a1 commit 51278c7

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ text-to-image generator. This fork supports:
1818
1. An interactive command-line interface that accepts the same prompt
1919
and switches as the Discord bot.
2020

21-
2. Support for img2img in which you provide a seed image to build on
22-
top of.
23-
24-
3. A basic Web interface that allows you to run a local web server for
21+
2. A basic Web interface that allows you to run a local web server for
2522
generating images in your browser.
26-
4. A notebook for running the code on Google Colab.
23+
24+
3. A notebook for running the code on Google Colab.
25+
26+
4. Support for img2img in which you provide a seed image to guide the
27+
image creation. (inpainting & masking coming soon)
2728

2829
5. Upscaling and face fixing using the optional ESRGAN and GFPGAN
2930
packages.
@@ -44,7 +45,8 @@ improvements and bug fixes.
4445
2. [Changelog](#latest)
4546
3. [Installation](#installation)
4647
4. [Troubleshooting](#troubleshooting)
47-
5. [Support](#support)
48+
5. [Contributing](#contributing)
49+
6. [Support](#support)
4850

4951
# Features
5052

@@ -394,10 +396,10 @@ repository and associated paper for details and limitations.
394396
- Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516)
395397
- WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling [Kevin Gibbons](https://github.com/bakkot)
396398
- WebUI supports incremental display of in-progress images during generation [Kevin Gibbons](https://github.com/bakkot)
397-
- Output directory can be specified on the dream> command line.
398-
- The grid was displaying duplicated images when not enough images to fill the final row [Muhammad Usama](https://github.com/SMUsamaShah)
399399
- Can specify --grid on dream.py command line as the default.
400400
- Miscellaneous internal bug and stability fixes.
401+
- Works on M1 Apple hardware.
402+
- Multiple bug fixes.
401403

402404
For older changelogs, please visit **[CHANGELOGS](CHANGELOG.md)**.
403405

@@ -723,6 +725,20 @@ of branch>
723725
You will need to go through the install procedure again, but it should
724726
be fast because all the dependencies are already loaded.
725727

728+
# Contributing
729+
730+
Anyone who wishes to contribute to this project, whether
731+
documentation, features, bug fixes, code cleanup, testing, or code
732+
reviews, is very much encouraged to do so. If you are unfamiliar with
733+
how to contribute to GitHub projects, here is a (Getting Started
734+
Guide)[https://opensource.com/article/19/7/create-pull-request-github].
735+
736+
A full set of contribution guidelines, along with templates, are in
737+
progress, but for now the most important thing is to **make your pull
738+
request against the "development" branch**, and not against
739+
"main". This will help keep public breakage to a minimum and will
740+
allow you to propose more radical changes.
741+
726742
# Support
727743

728744
For support,
@@ -735,8 +751,12 @@ _Contributions by:_
735751
[Peter Kowalczyk](https://github.com/slix), [Henry Harrison](https://github.com/hwharrison),
736752
[xraxra](https://github.com/xraxra), [bmaltais](https://github.com/bmaltais), [Sean McLellan](https://github.com/Oceanswave),
737753
[nicolai256](https://github.com/nicolai256), [Benjamin Warner](https://github.com/warner-benjamin),
738-
[tildebyte](https://github.com/tildebyte),[yunsaki](https://github.com/yunsaki)
739-
and [Tesseract Cat](https://github.com/TesseractCat)
754+
[tildebyte](https://github.com/tildebyte),[yunsaki](https://github.com/yunsaki), [James Reynolds][https://github.com/magnusviri],
755+
[Tesseract Cat](https://github.com/TesseractCat), and many more!
756+
757+
(If you have contributed and don't see your name on the list of
758+
contributors, please let lstein know about the omission, or make a
759+
pull request)
740760

741761
Original portions of the software are Copyright (c) 2020 Lincoln D. Stein (https://github.com/lstein)
742762

0 commit comments

Comments
 (0)