Skip to content

Commit 735a435

Browse files
authored
Update CONTRIBUTING.md
1 parent da375be commit 735a435

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

Diff for: CONTRIBUTING.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,13 @@
1111

1212
### Adding support for a new language
1313

14-
Before anything, you need to make sure that the language you want to add is supported by ([tokei](https://github.com/XAMPPRocky/tokei#supported-languages)).
15-
16-
Adding support for a new Language consists in adding a new entry in the `define_language!` macro in [language.rs](https://raw.githubusercontent.com/o2sh/onefetch/main/src/language.rs) in filling it in with the right data.
14+
Adding support for a new Language consists in adding a new entry to the `define_language!` macro in [language.rs](https://raw.githubusercontent.com/o2sh/onefetch/main/src/language.rs) and filling it in with the right data.
1715

1816
**Example**:
1917

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

22-
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.
20+
The first item `CSharp` corresponds to the name of the language as defined in [tokei](https://github.com/XAMPPRocky/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.
2321

2422
#### Ascii logo
2523

@@ -54,7 +52,7 @@ Remarks:
5452
- The ascii logo's dimensions must fall below `25*40` (height\*width); The CI will fail otherwise.
5553
- Use `{i}` to color the ascii with `i` the color index from the `vec!` of colors defined in `define_language!`.
5654
- Make sure to trim any unnecessary trailing whitespaces.
57-
- Check [Convert image to ASCII art](https://github.com/o2sh/onefetch/wiki/image-to-ascii) to learn more about image to ascii conversion.
55+
- Check ["Convert image to ASCII art"](https://github.com/o2sh/onefetch/wiki/image-to-ascii) to learn more about image to ascii conversion.
5856
- 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).
5957

6058
### Adding support for a new package manager

0 commit comments

Comments
 (0)