Skip to content

Commit 4361a37

Browse files
author
George K. Thiruvathukal
committed
Make landing page as simple as possible and point to Wiki for documentation
1 parent 423c82f commit 4361a37

File tree

1 file changed

+2
-22
lines changed

1 file changed

+2
-22
lines changed

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,7 @@
77
ZettelGeist is a plaintext notetaking system inspired by the Zettelkasten approach. As this README is intended to be minimal,
88
we encourage you to visit http://zettelgeist.com for additional details.
99

10-
# Installation
10+
# Getting Started
1111

12-
Installation is done via PyPI.
13-
```
14-
pip install zettelgeist
15-
```
12+
Please see the [ZettelGeist Wiki](https://github.com/ZettelGeist/zettelgeist/wiki) for detailed installation and usage instructions.
1613

17-
Power users can install by checking out the repo and running `setup.py` to install.
18-
19-
We recommend that you use a virtualenv as we are still in beta.
20-
21-
# Features
22-
23-
- A zettel is a "note card"
24-
- Zettels written using YAML
25-
- Zettels indexed using sqlite with FTS extensions
26-
- Zettel searched using a query language (ZQL = Zettel Query Language) similar to Gmail's search operators
27-
- Search results are rendered as a folder of zettels
28-
- Replacement can be done on a set of notes to change any YAML field
29-
- command-line and text editor driven workflow
30-
31-
For details, please see the main web site. This is where we'll provide full user documentation and recipes to help you get started.
32-
We are developer-users of this project and are presently working on our own book. ZettelGeist is being used to organize all of the
33-
research for our book. So if it doesn't work for us, it probably won't work for you!

0 commit comments

Comments
 (0)