zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2024-12-26 09:12:08 +08:00
Code Issues Projects Releases Packages Wiki Activity

readme update

Browse source
This commit is contained in:
azivner 2018-08-30 11:56:12 +02:00
parent a2d7be445f
commit dcc770c443
1 changed files with 15 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -5,44 +5,39 @@ Trilium Notes is a hierarchical note taking application. Picture tells a thousan
![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) ![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png)
See other pictures in [screenshot tour](https://github.com/zadam/trilium/wiki/Screenshot-tour).
## Features ## Features
* Notes can be arranged into arbitrarily deep hierarchy * Notes can be arranged into arbitrarily deep hierarchy (tree)
* Notes can have more than 1 parents - see [cloning](https://github.com/zadam/trilium/wiki/Cloning-notes) * Notes can have more than 1 parents - see [cloning](https://github.com/zadam/trilium/wiki/Cloning-notes)
* WYSIWYG (What You See Is What You Get) editing * WYSIWYG (What You See Is What You Get) editing
* Support for editing notes with source code, including syntax highlighting
* Fast and easy [navigation between notes](https://github.com/zadam/trilium/wiki/Note-navigation) * Fast and easy [navigation between notes](https://github.com/zadam/trilium/wiki/Note-navigation)
* Seamless note versioning * Seamless [note versioning](https://github.com/zadam/trilium/wiki/Note-revisions)
* Note labels can be used to tag/label notes as an alternative note organization and querying * Note [attributes](https://github.com/zadam/trilium/wiki/Attributes) can be used to notes as an alternative for note organization and querying
* Can be deployed as web application and / or desktop application with offline access (electron based) * Can be deployed as web application and / or desktop application with offline access (electron based)
* [Synchronization with](https://github.com/zadam/trilium/wiki/Synchronization) self-hosted sync server * [Synchronization](https://github.com/zadam/trilium/wiki/Synchronization) with self-hosted sync server
* Strong [note encryption](https://github.com/zadam/trilium/wiki/Protected-notes) * Strong [note encryption](https://github.com/zadam/trilium/wiki/Protected-notes)
* [Scripting](https://github.com/zadam/trilium/wiki/Scripts) - see [Advanced showcases](https://github.com/zadam/trilium/wiki/Advanced-showcases)
## Builds ## Builds
* If you want to install Trilium on server, follow [this page](https://github.com/zadam/trilium/wiki/Installation-as-webapp) * If you want to install Trilium on server, follow [this page](https://github.com/zadam/trilium/wiki/Server-installation)
* If you want to use Trilium on the desktop, download binary release for your platform from [latest release](https://github.com/zadam/trilium/releases/latest), unzip the package and run ```trilium``` executable. * If you want to use Trilium on the desktop, download binary release for your platform from [latest release](https://github.com/zadam/trilium/releases/latest), unzip the package and run ```trilium``` executable.
## Supported platforms ## Supported platforms
Desktop (electron-based) 64-bit builds are available for Linux and Windows. Desktop (electron-based) 64-bit builds are available for Linux and Windows.
Requirements for web based installation are [outlined here](https://github.com/zadam/trilium/wiki/Installation-as-webapp). Requirements for web based installation are [outlined here](https://github.com/zadam/trilium/wiki/Server-installation).
Currently only recent Chrome and Firefox are supported (tested) browsers. Other modern browsers (not IE) might work as well. Currently only recent Chrome and Firefox are supported (tested) browsers. Other modern browsers (not IE) might work as well.
## Status
This is beta quality software. While it is reasonably feature complete and is tested by its author, it lacks proper testing by more users. It's not yet recommended for daily use, but testing and experimentation is encouraged.
## Documentation ## Documentation
List of documentation pages: [See wiki for complete list of documentation pages.](https://github.com/zadam/trilium/wiki/)
* [Installation as webapp](https://github.com/zadam/trilium/wiki/Installation-as-webapp)
* [Note navigation](https://github.com/zadam/trilium/wiki/Note-navigation)
* [Tree manipulation](https://github.com/zadam/trilium/wiki/Tree-manipulation)
* [Labels](https://github.com/zadam/trilium/wiki/Labels)
* [Links](https://github.com/zadam/trilium/wiki/Links)
* [Cloning notes](https://github.com/zadam/trilium/wiki/Cloning-notes)
* [Protected notes](https://github.com/zadam/trilium/wiki/Protected-notes)
* [Synchronization](https://github.com/zadam/trilium/wiki/Synchronization)
* [Document](https://github.com/zadam/trilium/wiki/Document)
* [Theming](https://github.com/zadam/trilium/wiki/Theming)
* [Keyboard shortcuts](https://github.com/zadam/trilium/wiki/Keyboard-shortcuts)
* [Troubleshooting](https://github.com/zadam/trilium/wiki/Troubleshooting)