commit afa57f7871c009722674495177041fd7abbb39ef from: Omar Polo date: Thu Jul 15 10:21:22 2021 UTC add section about user files commit - 422f2758667f9e90c6a9ad4c8e14099e1925a965 commit + afa57f7871c009722674495177041fd7abbb39ef blob - 85c96114b770cca338e693765d8cc7a0cbc847fe blob + c194aa819fb5d7f68d1ef57737d9645c0f33beec --- README.md +++ README.md @@ -101,6 +101,18 @@ comprehensive testing on various platforms is done to is working as intended. +## User files + +Telescope stores user files in `~/.telescope`. The usage and contents +of these files are described in [the man page](telescope.1), under +"FILES". There's no support yet for XDG-style directories. + +A sample config file is included in `contrib/sample.config`. Copy it +as `~/.telescope/config` to apply it. + +Only one instance of Telescope can be running at time per user. + + ## License Telescope is distributed under a BSD-style licence. The main code is