~fkfd/utab

74daf13df3506ff30a44b9743ef564b5cc9cecd1 — Frederick Yin 2 years ago f1658d8
Add known defects to readme
1 files changed, 7 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +7 -0
@@ 95,6 95,13 @@ To run it inside the command line, run `python -m utab`. It will start running a
3. Install new version: `python setup.py install`
4. Your configs and data will remain untouched if they exist in your data dir. If you wish, you can copy some of them from `utab/data/` and overwrite the old ones. Alternatively, do a backup for your `sites.csv`, completely overwrite, then move that back in.

## Known Defects

- The grid doesn't align if there is an odd-numbered amount of cells on the last row when your grid width is even, and vice versa. Instead, they are centered.
- When you set title of a site too long, it will break into multiple lines and the cell will misalign (shift upward).
- The favicons are cached, or they are not. In the latter case, additional traffic cost may be induced.
- The CSS I wrote is the best exemplification of "it works on my machine".

## Contributing

There are three ways to contribute. One is bug reports in the provided scope. If so, contact `fkfd at macaw dot me`. Another is feature requests. If I'm interested, I may spin up a mailing list and we collaborate. Then there's forking. This is the preferred method if you are to introduce a lot of changes. Configurability is limited by design in my version of utab, to make codebase lightweight. Fork this project and do whatever 0BSD allows (i.e. anything). Thank you.