Git Product home page Git Product logo

dach's Introduction

Satori

Dach: Democratizing the creation of elegant banners for everyone's project.

Note This project is currently in its early stages of development, and there may be instances where it is either not functioning as intended or experiencing issues. Your feedback, as well as any identified issues or contributions, would be greatly appreciated in shaping its future progress. I still consider myself a beginner in software development, so I would greatly appreciate your understanding. ♥️

Installation

  npm i -g dach

Overview

Features

  • Generate banners using a wide variety of predefined themes.
  • Create and add new themes via the web toolkit.
  • And much incoming!

Description

Dach is a command-line tool that you will most likely use only once per project. Its strength lies in the ability to create themes for it using the web toolkit. You can then apply these themes to your personal or organizational projects. Currently, customization options are somewhat limited and opinionated, but they will likely undergo slight changes in the future as the project evolves.

Usage

To generate a default banner, simply run dach generate in your project's directory.

Banner using predefined theme and rounded corners:

dach generate  \
  --theme funk  \
  --title "Funk" \
  --description "Example description" \
  --rounded-corners \
  --output "."

Banner with custom output directory:

dach generate    \
  --theme elegant \
  --title "Output" \
  --description "Custom output directory" \
  --output "./my-dir"

Banner with custom dimensions:

dach generate \
  --theme funk \
  --title "Hello" \
  --description "Worlds" \
  --dimensions "1920x1200" \
  --output "."

Commands

Generate

dach generate, Generates a banner using provided arguments.

Option Alias Description Default
--output -o Path to output directory. CWD/.github
--title -t Banner title. Untitled
--description -d Banner description. Project description
--rounded-corners -rc Rounded corners. false
--theme - Theme of banner. elegant

Add

dach add <name>, Adds a new theme to the list of available themes.

Option Alias Description Default
--colors -c Colors of theme. -
--positions -p Position coordinates for each color. -
--title-color -t Color of title. -
--description-color -d Color of the description. -
--dimensions -dim Dimensions of banner. 3000x1685
--ratio -r Width to height ratio of banner. 16:9

Example banners

Blaze

Blaze

Pearl

Pearl

Elegant

Elegant

Peach

Peach

Flora

Flora

Lotus

Lotus

Contributing

All contributions are much appreciated. Guidelines TBD.

License

Maciej Kukielka | MIT License

dach's People

Contributors

7sne avatar

Watchers

 avatar

dach's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.