mirror of
https://github.com/talwat/lowfi
synced 2025-12-31 11:03:21 +00:00
docs: move english to the root docs directory
yes, this is an anglocentric decision. lowfi's code is in english, i am sorry francophones.
This commit is contained in:
parent
0dc3eddab7
commit
fa236439e3
@ -1,6 +1,6 @@
|
||||
# Contributing to lowfi
|
||||
|
||||
[[version française](./docs/fr/CONTRIBUER.md)]
|
||||
[[Version française](./docs/fr/CONTRIBUER.md)]
|
||||
|
||||
There are a few guidelines outlined here that will make it more likely for your PR to be accepted.
|
||||
Only ones that are less obvious are going to be listed. If you need to ask, it's probably a no.
|
||||
|
||||
10
README.md
10
README.md
@ -1,17 +1,17 @@
|
||||
# lowfi
|
||||
|
||||
[[version française](./docs/fr/README.md)]
|
||||
[[Version française](./docs/fr/README.md)]
|
||||
|
||||
lowfi is a tiny rust app that serves a single purpose: play lofi.
|
||||
It'll do this as simply as it can: no albums, no ads, just lofi.
|
||||
|
||||

|
||||

|
||||
|
||||
## Disclaimer
|
||||
|
||||
As of the 1.7.0 version of lowfi, **all** of the audio files embedded
|
||||
by default are from [chillhop](https://chillhop.com/). Read
|
||||
[MUSIC.md](./docs/en/MUSIC.md) for more information.
|
||||
[MUSIC](./docs/MUSIC.md) for more information.
|
||||
|
||||
## Why?
|
||||
|
||||
@ -147,7 +147,7 @@ and as such are also stored in the same directory.
|
||||
### Extra Flags
|
||||
|
||||
If you have something you'd like to tweak about lowfi, you use additional flags which
|
||||
slightly tweak the UI or behaviour of the menu. The flags can be viewed with `lowfi --help`.
|
||||
slightly tweak the UI or behavior of the menu. The flags can be viewed with `lowfi --help`.
|
||||
|
||||
| Flag | Function |
|
||||
| ----------------------------------- | --------------------------------------------------- |
|
||||
@ -162,6 +162,8 @@ slightly tweak the UI or behaviour of the menu. The flags can be viewed with `lo
|
||||
| `-t`, `--track-list <TRACK_LIST>` | Use a [custom track list](#custom-track-lists) |
|
||||
| `-s`, `--buffer-size <BUFFER_SIZE>` | Internal song buffer size [default: 5] |
|
||||
|
||||
If you need something even more specific, see [ENVIRONMENT_VARS](./docs/ENVIRONMENT_VARS.md).
|
||||
|
||||
### Extra Features
|
||||
|
||||
lowfi uses cargo/rust's "feature" system to make certain parts of the program optional,
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Environment Variables
|
||||
|
||||
[[version française](../fr/ENVIRONMENT_VARS.md)]
|
||||
[[Version française](./fr/ENVIRONMENT_VARS.md)]
|
||||
|
||||
lowfi has some more specific options, usually as a result of minor feature requests, which are only documented here.
|
||||
If you have some behavior you'd like to change, which is quite specific, then see if one of these options suits you.
|
||||
@ -1,6 +1,6 @@
|
||||
# The State of lowfi's Music
|
||||
|
||||
[[version française](../fr/MUSIQUE.md)]
|
||||
[[Version française](./fr/MUSIQUE.md)]
|
||||
|
||||
> [!WARNING]
|
||||
> This document will be a bit long and has almost nothing to do with the actual
|
||||
@ -10,7 +10,7 @@ Vous pouvez utiliser l'IA pour chercher, ou s'il y a quelque chose de mineur et
|
||||
Cela dit, si l'usage d'IA est visible, c'est déjà trop.
|
||||
Les PR générées par IA n'aident pas les développeurs, elles sont juste embêtantes et leur font perdre leur temps.
|
||||
|
||||
## 2. petit = mieux
|
||||
## 2. Petit = mieux
|
||||
|
||||
Faites en sorte que chaque PR ne contienne qu'une fonctionnalité distincte. Ajouter plusieurs fonctionnalités dans une seule PR est généralement une mauvaise idée.
|
||||
Cela permet aussi que des fonctionnalités spécifiques soit approuvées ou refusées au cas par cas, plutot qu'un seul bloc de code important.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user