refine README

This commit is contained in:
Le Tan 2017-08-22 21:54:41 +08:00
parent dc98b5ef00
commit c177dd89cb
2 changed files with 57 additions and 23 deletions

View File

@ -17,9 +17,10 @@ Users from China can download the latest release of VNote from [Baidu Netdisk](h
## Linux ## Linux
[![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote) [![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote)
**NOT** ready yet! Please help yourself to compile and build it from sources. There is an AppImage format standalone executable of VNote for major Linux distributions. **Any help for packaging and distribution on Linux is appreciated!**
**Any help for packaging and distribution on Linux is appreciated!** - [Github releases](https://github.com/tamlok/vnote/releases)
- Latest builds on master: [ ![Download](https://api.bintray.com/packages/tamlok/vnote/vnote/images/download.svg) ](https://bintray.com/tamlok/vnote/vnote/_latestVersion)
## MacOS ## MacOS
[![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote) [![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote)
@ -133,6 +134,8 @@ VNote also supports many other features, like:
- Auto indent and auto list; - Auto indent and auto list;
# Build & Development # Build & Development
VNote needs Qt 5.7 or above to build.
1. Clone & Init 1. Clone & Init
``` ```
git clone https://github.com/tamlok/vnote.git vnote.git git clone https://github.com/tamlok/vnote.git vnote.git
@ -141,17 +144,30 @@ VNote also supports many other features, like:
``` ```
2. Download Qt & Have Fun 2. Download Qt & Have Fun
Download [Qt 5.7.0](http://info.qt.io/download-qt-for-application-development) and open `VNote.pro` as a project. Download [Qt 5.7.0](http://info.qt.io/download-qt-for-application-development) and open `VNote.pro` as a project.
3. Or if you prefer command line on Linux, you could follow these steps:
## Linux
If your distribution does not have Qt 5.7 or above, you need to add it from other sources. In Ubuntu, you could do this:
```
sudo add-apt-repository ppa:beineri/opt-qt571-trusty -y
sudo apt-get update -qq
sudo apt-get -y install qt57base qt57webengine qt57webchannel qt57svg qt57location qt57tools qt57translations
source /opt/qt*/bin/qt*-env.sh
```
After Qt and some necessary modules are ready, you could follow these steps to build VNote
``` ```
cd vnote.git cd vnote.git
mkdir build mkdir build
cd build cd build
# May need to use the qmake in your downloaded Qt.
qmake ../VNote.pro qmake ../VNote.pro
make make
sudo make install sudo make install
``` ```
For details, you could reference `.travis_linux.sh` in the source root.
## MacOS ## MacOS
If you prefer command line on macOS, you could follow these steps. If you prefer command line on macOS, you could follow these steps.

View File

@ -17,7 +17,10 @@
## Linux ## Linux
[![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote) [![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote)
目前只能由用户自行从源代码构建编译暂时还没有打包发布。希望了解Linux系统下打包发布的开发人员能提供这方面的帮助 VNote当前为主要Linux发行版提供了一个AppImage格式的独立可执行文件。希望了解Linux系统下打包发布的开发人员能提供这方面进一步的帮助
- [Github releases](https://github.com/tamlok/vnote/releases)
- master分支的最新构建[ ![Download](https://api.bintray.com/packages/tamlok/vnote/vnote/images/download.svg) ](https://bintray.com/tamlok/vnote/vnote/_latestVersion)
## MacOS ## MacOS
[![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote) [![Build Status](https://travis-ci.org/tamlok/vnote.svg?branch=master)](https://travis-ci.org/tamlok/vnote)
@ -132,6 +135,8 @@ VNote还支持其他很多的功能比如
- 自动缩进和自动列表; - 自动缩进和自动列表;
# 构建与开发 # 构建与开发
VNote需要5.7版本以上的Qt进行构建。
1. 克隆代码仓库 1. 克隆代码仓库
``` ```
git clone https://github.com/tamlok/vnote.git vnote.git git clone https://github.com/tamlok/vnote.git vnote.git
@ -140,17 +145,30 @@ VNote还支持其他很多的功能比如
``` ```
2. 下载Qt 2. 下载Qt
下载[Qt 5.7.0](http://info.qt.io/download-qt-for-application-development),导入`VNote.pro`创建一个工程。 下载[Qt 5.7.0](http://info.qt.io/download-qt-for-application-development),导入`VNote.pro`创建一个工程。
3. 或者在Linux命令行下您可以执行以下命令来编译和安装
## Linux
如果您的Linux发行版不提供5.7以上版本的Qt那么您需要从其他来源获取Qt。在Ubuntu中您可以执行以下步骤
```
sudo add-apt-repository ppa:beineri/opt-qt571-trusty -y
sudo apt-get update -qq
sudo apt-get -y install qt57base qt57webengine qt57webchannel qt57svg qt57location qt57tools qt57translations
source /opt/qt*/bin/qt*-env.sh
```
当Qt和相关的模块准备就绪后您可以执行以下命令来编译和安装
``` ```
cd vnote.git cd vnote.git
mkdir build mkdir build
cd build cd build
# May need to use the qmake in your downloaded Qt.
qmake ../VNote.pro qmake ../VNote.pro
make make
sudo make install sudo make install
``` ```
更多细节,您可以参考源代码根目录下的`.travis_linux.sh`
## MacOS ## MacOS
在macOS下您可以执行以下步骤来编译 在macOS下您可以执行以下步骤来编译