Skip to content

Commit

Permalink
#1290, add getting started section in Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
o2sh committed Mar 23, 2024
1 parent 7264d5c commit 37719a8
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### Getting started

Follow the instructions for [installing onefetch from source](https://github.com/o2sh/onefetch/wiki/Installation#build-from-source).

### Adding support for a new language

Adding support for a new Language consists in adding a new entry to [language.yaml](./languages.yaml) and filling it in with the right data.
Expand Down Expand Up @@ -39,11 +43,11 @@ CSharp: # required, this will be the name of the enum variant for the language a
- 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).
- "#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#`
```
Expand Down

0 comments on commit 37719a8

Please sign in to comment.