CuteEngineering/cutekit
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

doc: add install guide in readme.md

Browse source
This commit is contained in:
Supercip971 2023-08-03 15:44:42 -04:00
parent 6a599bc343
commit ad4dd3cfad
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -30,6 +30,21 @@
- ✨ It's **easy**: the [**templates**](./doc/templates.md) help the user quick-start a project. - ✨ It's **easy**: the [**templates**](./doc/templates.md) help the user quick-start a project.
- ✨ It's **portable**: Cutekit can run on MacOS Gnu/Linux and Windows. - ✨ It's **portable**: Cutekit can run on MacOS Gnu/Linux and Windows.
## Installation
To install Cutekit, you may use your favourite package manager if it is available. Or you can install it manually by following the instructions below.
```bash
$ git clone https://github.com/cute-engineering/cutekit
$ cd cutekit
# If you want to use the latest version of Cutekit, you can switch to the dev branch.
# $ git switch dev
$ pip install --user -e .
```
## Quick-start ## Quick-start
-> If you directly want to start using Cutekit for a new project, you can just run `$ ck I host` and it will create a new project in the host directory (you can rename it later). -> If you directly want to start using Cutekit for a new project, you can just run `$ ck I host` and it will create a new project in the host directory (you can rename it later).