michael/panorama
1
0
Fork 0
Code Issues 11 Pull requests Projects 1 Releases Wiki Activity

add docs

Browse source
This commit is contained in:
Michael Zhang 2021-03-08 18:32:01 -06:00
parent 46567c43e1
commit e78a83aec7
Signed by: michael
GPG key ID: BDA47A31A3C8EE6B
2 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/src/config.md
View file

@ -1,6 +1,7 @@
# Config # Config
Configuration is done by editing `$XDG_CONFIG_HOME/panorama/panorama.toml`. It Configuration is done by editing `$XDG_CONFIG_HOME/panorama/panorama.toml`.
This is usually found somewhere like `$HOME/.config/panorama/panorama.toml` It
follows the [TOML][1] file format, and the data structures are defined in code follows the [TOML][1] file format, and the data structures are defined in code
at `src/config.rs`. at `src/config.rs`.

14
docs/src/intro.md
View file

@ -4,4 +4,18 @@ Panorama is a personal information manager.
[Click here for API docs][1] [Click here for API docs][1]
## Quick Start
Since panorama is still in active development, install from git master with
```
cargo install panorama --git https://github.com/iptq/panorama
```
Then, create a config file. The format along with examples can be found in
[this page of the manual][2].
That's it! Run `panorama` forever.
[1]: https://pim.mzhang.io/api/panorama/ [1]: https://pim.mzhang.io/api/panorama/
[2]: ./config.md