Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
o2sh authored Jul 2, 2021
1 parent 16a971b commit f4869ee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Adding support for a new Language consists in adding a new entry in the `define_

` { CSharp, "csharp.ascii", define_colors!( [Color::Blue, Color::Magenta] ), "c#" }, `

The first item `CSharp` corresponds to the name of the language as defined in tokei. The second item `csharp.ascii` is the name of the file containing the ascii logo: this file has to be placed in the _./resources_ folder (more info below). Then we have the colors used to customize the look of the ascii logo when displayed to the screen. The last item `c#` is only required if the Enum name `CSharp` doesn't match the display name `C#` and is used as input for `-a, --ascii-language <LANGUAGE>` - by default we take the Enum name in lowercase.
The first item `CSharp` corresponds to the name of the language as defined in tokei. The second item `csharp.ascii` is the name of the file containing the ascii logo: this file has to be placed in the _./resources_ folder (more info below). Then we have the colors used to customize the look of the ascii logo when displayed to the screen. The last item `c#` is only required if the Enum name `CSharp` doesn't match the display name `C#` and is used as an input for `-a, --ascii-language <LANGUAGE>` - by default we take the Enum name in lowercase.

#### Ascii logo

Expand Down Expand Up @@ -55,7 +55,7 @@ Remarks:
- Use `{i}` to color the ascii with `i` the color index from the `vec!` of colors defined in `define_language!`.
- Make sure to trim any unnecessary trailing whitespaces.
- Check [Convert image to ASCII art](https://github.com/o2sh/onefetch/wiki/image-to-ascii) to learn more about image to ascii conversion.
- Optionally, you may provide a `vec!` of colors in `rgb` format as an alternative to basic colors for terminals that can support it, more info [here](https://gist.github.com/XVilka/8346728).
- Optionally, you may provide a `vec!` of colors in `rgb` format as an alternative to basic colors for terminals that support [true colour](https://gist.github.com/XVilka/8346728).

### Adding support for a new package manager

Expand Down Expand Up @@ -97,8 +97,8 @@ These translations will be accessible directly from the English README.md via hy

<p align="center">:heart::heart:</p>

<a href="https://github.com/o2sh/onefetch/graphs/contributors">
<p align="center">
<img src="https://contrib.rocks/image?repo=o2sh/onefetch" />
</a>
</p>

Made with [contributors-img](https://contrib.rocks).

0 comments on commit f4869ee

Please sign in to comment.