From 1c5fa52997dd1542d2efab446d89ee99268b98df Mon Sep 17 00:00:00 2001 From: flywind <43030857+xflywind@users.noreply.github.com> Date: Sat, 8 Aug 2020 16:50:09 +0800 Subject: [PATCH] docs --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f61af67..ba8ba86 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # logue Command tools for Prologue in Nim. +# Installation +``` +nimble install logue +``` + +Make sure `~/.nimble/bin` is in your environment variables. + ## Usage Use `logue init yourprojectname` to initialize your project. + +For example, type command `logue init helloworld` to initialize. This will create program +structure like this: + +``` +- helloworld + .env + app.nim + urls.nim + views.nim +``` + +You must switch to `/.../helloworld` directory to run `app.nim`.