1
0
mirror of https://github.com/o2sh/onefetch synced 2024-07-02 15:48:51 +00:00
onefetch/CONTRIBUTING.md
Ossama Hjaji ed96c4547d
Add manifest crate (#851)
* add manifest crate

* read deps and repo_name from manifest

* fix tests

* address some PR comments

* use Option<&T> instead of &Option<T>

* merge two functions in manifest crate

* read version from manifest

* revert last commit

* fallback to manifest for version

* avoid panicking when reading cargo.toml is workspace and not package

* rename manifest to onefetch-manifest and create workspace

* fix typo

* cargo clippy

* remove Cargo.lock from manifest

* break line after every 5 words in the description

* Update src/info/repo/description.rs

Co-authored-by: Spenser Black <spenserblack01@gmail.com>

* add fallback to manifest entry for license info line

* remove section in contributing.md about adding support for a package manager

* Update manifest/Cargo.toml

Co-authored-by: Spenser Black <spenserblack01@gmail.com>

* fix Cargo.toml

* add integration test for manifest (cargo)

* add integration test for manifest (npm)

* revert new line

* update screenshots

* update screenshots

* add unit test for long description

* add unit test to dependencies

* update manifest's readme

Co-authored-by: Spenser Black <spenserblack01@gmail.com>
2022-11-12 12:21:41 +01:00

3.3 KiB

Adding support for a new language

Adding support for a new Language consists in adding a new entry to language.yaml and filling it in with the right data.

Example:

CSharp: # required, this will be the name of the enum variant for the language as specified by tokei (link 1)
  type: programming # required, can be programming, data, markup, or prose as specified by linguist (link 2)
  # required, this is the logo. If it's not within 25x40 bounds, you will get a compiler error. Use `{i}` to color the ascii with `i` the color index.
  ascii: |
    {0}                 ++++++
    {0}              ++++++++++++
    {0}          ++++++++++++++++++++
    {0}       ++++++++++++++++++++++++++
    {0}    ++++++++++++++++++++++++++++++++
    {0} +++++++++++++{3}************{0}+++++++++++++
    {0}+++++++++++{3}******************{0}++++++++{2};;;
    {0}+++++++++{3}**********************{0}++{2};;;;;;;
    {0}++++++++{3}*********{0}++++++{3}******{2};;;;;;;;;;;
    {0}+++++++{3}********{0}++++++++++{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++++++++{2};;;;;;{3}*********{2}::
    {0}+++++++{3}******{0}+++++++{2};;;;;;;;;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++{1}:::::{2};;;;;;;{3}*********{2};;
    {0}+++++++{3}********{1}::::::::::{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}++++++++{3}*********{1}::::::{3}******{2};;;;;;;;;;;
    {0}++++++{1}:::{3}**********************{1}::{2};;;;;;;
    {0}+++{1}::::::::{3}******************{1}::::::::{2};;;
    {1} :::::::::::::{3}************{1}:::::::::::::
    {1}    ::::::::::::::::::::::::::::::::
    {1}       ::::::::::::::::::::::::::
    {1}          ::::::::::::::::::::
    {1}              ::::::::::::
    {1}                 ::::::
  colors:
    ansi: # required, a list of the ANSI colors used to colorize the logo
      - blue
      - magenta
      - magenta
      - white
    hex: # optional, alternative to basic colors for terminals that support true colour.
      - '#9B4F97'
      - '#67217A'
      - '#803788'
      - '#FFFFFF'
    chip: '#178600' # required, this is used for the language breakdown bar, its value can be found in linguist (link 2).
  serialization: c# # required only if the Enum name `CSharp` doesn't match the display name `C#`

Adding translation for README.md

In order to make Onefetch more accessible for non English-speakers, we are seeking the help of multilingual contributors willing to translate the README.md in their native tongue.

These translations will be accessible directly from the English README.md via hyperlinks.

Special Thanks to

❤️❤️

Made with contributors-img.