Skip to content

Commit

Permalink
Merge 4dc4235 into fdc6fc0
Browse files Browse the repository at this point in the history
  • Loading branch information
Eliot00 committed Dec 30, 2021
2 parents fdc6fc0 + 4dc4235 commit 593009c
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,26 @@ Screenshots:

Roadmap: [Roadmap](https://github.com/phodal/quake/discussions/20)

## Install

### GitHub release

download from Github release

### cargo

if you has rust toolchains, use `cargo install quake`

### Nix

for Nix user, use `nix-env -iA nixos.inherd-quake`, or `nix-env -iA nixpkgs.inherd-quake` in Non-NixOS environment

## Usage

1. download from release or `cargo install quake`
2. download web from release
3. init with `quake init`
4. use `quake cmd -i "todo.add: hello, world"` to add new todo
5. use `quake server` to start server (ps: need to install `meilisearch` for search entries).
1. download web from release
2. init with `quake init` or skip step 1 and use `quake init -d`
3. use `quake cmd -i "todo.add: hello, world"` to add new todo
4. use `quake server` to start server (ps: need to install `meilisearch` for search entries).

more for [Setup](examples/quake_book/0002-setup.md);

Expand Down

0 comments on commit 593009c

Please sign in to comment.