Metadata-Version: 2.1
Name: Jianmu
Version: 0.0.2
Summary: A simple desktop app development framework combining Python, Vue.js, Element Plus and Electron.
Home-page: https://github.com/frederick-wang/jianmu
Author: Zhaoji Wang
Author-email: hwoam@outlook.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/frederick-wang/jianmu/issues
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Jianmu (建木)

Jianmu is a simple desktop app development framework combining Python, Vue.js, Element Plus and Electron.

## Installation

### Python Version

We recommend using the latest version of Python. Jianmu supports Python 3.6 and newer.

### Install Jianmu

To install the jianmu package, use the following command:

```sh
pip install jianmu
```

Jianmu is now installed. After installation, you will have access to the `jianmu` binary in your command line. You can verify that it is properly installed by simply running `jianmu` command or `python -m jianmu`, which should present you with a help message listing all available commands.

You can check you have the right version with this command:

```sh
jianmu --version
```

## Usage

To create a new project, run:

```sh
jianmu create <project-name>
```

To run your application in development mode, navigate to your project directory and run:

```sh
jianmu dev
```

To run your application in production mode, navigate to your project directory and run:

```sh
jianmu start
```

To build your application for a software release, navigate to your project directory and run:

```sh
jianmu build
```


