diff --git a/README.md b/README.md index da2a15e..899fe36 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[中文](https://github.com/leanote/leanote#1-介绍) + ## 1. Introduction @@ -107,111 +107,6 @@ Please fork this repository and contribute back using [pull requests](https://gi * QQ Group: 158716820 ----------------------------------------------------------------------- - -## 1. 介绍 - -Leanote, 不只是笔记! -![leanote.png](leanote.png "") - -**特性** - -* 知识管理: 通过leanote来管理知识, leanote有易操作的界面, 包含两款编辑器tinymce和markdown. 在leanote, 你可以尽情享受写作. -* 分享: 你也可以通过分享知识给好友, 让好友拥有你的知识. -* 协作: 在分享的同时也可以与好友一起协作知识. -* 博客: leanote也可以作为你的博客, 将知识公开成博客, 让leanote把你的知识传播的更远! - -## 2. 为什么我们要创建leanote? -说实话, 我们曾是evernote的忠实粉丝, 但是我们也发现evernote的不足: -* evernote的编辑器不能满足我们的需求, 不能贴代码(格式会乱掉, 作为程序员, 代码是我们的基本需求啊), 图片不能缩放. -* 我们是markdown的爱好者, 可是evernote竟然没有. -* 我们也想将知识公开, 所以我们有自己的博客, 如wordpress, 但为什么这两者不能合二为一呢? -* 还有... - -## 3.安装leanote -leanote是一款私有云笔记, 你可以下载它安装在自己的服务器上, 当然也可以在 http://leanote.com 上注册. - -这里详细整理了leanote二进版和leanote开发版的安装教程, 请移步至: -* [leanote二进制详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) -* [leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) - -### 3.1. 下载leanote - -Leanote V1.0-beta.2 已发布, 二进制文件(暂时没有windows版的): - -* Linux: [leanote-linux-x86_64.v1.0-beta.2.bin.tar.gz](https://github.com/leanote/leanote/releases/download/1.0-beta/leanote-linux-x86_64.v1.0-beta.2.bin.tar.gz) -* MacOS X: [leanote-mac-x86_64.v1.0-beta.2.bin.tar.gz](https://github.com/leanote/leanote/releases/download/1.0-beta/leanote-mac-x86_64.v1.0-beta.2.bin.tar.gz) - -或者直接检出[Leanote bin repository](https://github.com/leanote/leanote-bin) (推荐, 因为为最新版本) - -### 3.2. 安装 MongodbDB - -Leanote是由golang(使用[revel](https://revel.github.io/)框架 和 [MongoDB](https://www.mongodb.org)数据库), 你需要先安装Mongodb. - -安装MongodbDB, 导入数据更多细节请查看: [wiki](https://github.com/leanote/leanote/wiki/Install-Mongodb) - -### 3.3. 导入初始数据 - -MongodbDB初始数据在 `[PATH_TO_LEANOTE]/mongodb_backup/leanote_install_data` - -``` -$> mongorestore -h localhost -d leanote --directoryperdb PATH_TO_LEANOTE/mongodb_backup/leanote_install_data -``` - -初始数据包含两个用户: - -``` -user2 username: admin, password: abc123 (管理员, 重要!) -user3 username: demo@leanote.com, password: demo@leanote.com (为体验使用) -``` - -### 3.4. 配置 - -修改 `[PATH_TO_LEANOTE]/conf/app.conf`. 有以下选项: - -``mongodb`` **必须配置!** - -```Shell -db.host=localhost -db.port=27017 -db.dbname=leanote -db.username= -db.password= -``` - -``app.secret`` **重要** -请随意修改一个, app的密钥, 不能使用默认的, 不然会有安全问题 - -更多配置请查看 `app/app.conf` 和 [revel 手册](https://revel.github.io/) - -### 3.5. 运行leanote - -``` -$> cd PATH_TO_LEANOTE/bin -$> sudo sh run.sh -``` - -## 4. 如何对leanote进行二次开发 - -请查看 [How-to-develop-leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote) - -## 5. 贡献者 -多谢 [贡献者](https://github.com/leanote/leanote/graphs/contributors) 的贡献, leanote因有你们而更完美! - -## 6. 加入我们 - -欢迎提交[pull requests](https://github.com/leanote/leanote/pulls) 到leanote. - -leanote还有很多问题, 如果你喜欢它, 欢迎加入我们一起完善leanote. - -## 相关文档 -* [leanote二进制版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) -* [leanote开发版详细安装教程](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) -* [Leanote source leanote源码导读](https://github.com/leanote/leanote/wiki/Leanote-source-leanote源码导读) -* [leanote blog theme api(中文版)](https://github.com/leanote/leanote/wiki/leanote-blog-theme-api) -* [How to develop leanote 如何开发leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-如何开发leanote) +[中文](https://github.com/leanote/leanote#1-介绍) -## 讨论 -* [leanote 社区](http://bbs.leanote.com) -* QQ群: 158716820 -* [leanote google group](https://groups.google.com/forum/#!forum/leanote) diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..defc85b --- /dev/null +++ b/README_zh.md @@ -0,0 +1,113 @@ + +# LeanoteƷ + +## 1. + +Leanote, ֻDZʼ! +![leanote.png](leanote.png "") + +**** + +* ֪ʶ: ͨleanote֪ʶ, leanoteײĽ, ༭tinymcemarkdown. leanote, Ծд. +* : Ҳ֪ͨʶ, úӵ֪ʶ. +* Э: ڷͬʱҲһЭ֪ʶ. +* : leanoteҲΪIJ, ֪ʶɲ, leanote֪ʶĸԶ! + +## 2. ΪʲôҪleanote? +˵ʵ, evernoteʵ˿, ҲevernoteIJ: +* evernoteı༭ǵ, (ʽҵ, ΪԱ, ǵĻ), ͼƬ. +* markdownİ, evernoteȻû. +* Ҳ뽫֪ʶ, ԼIJ, wordpress, Ϊʲô߲ܺ϶Ϊһ? +* ... + +## 3.װleanote +leanoteһ˽Ʊʼ, װԼķ, ȻҲ http://leanote.com ע. + +ϸleanoteleanoteİװ̳, Ʋ: +* [leanoteϸװ̳](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) +* [leanoteϸװ̳](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) + +### 3.1. leanote + +Leanote V1.0-beta.2 ѷ, ļ(ʱûwindows): + +* Linux: [leanote-linux-x86_64.v1.0-beta.2.bin.tar.gz](https://github.com/leanote/leanote/releases/download/1.0-beta/leanote-linux-x86_64.v1.0-beta.2.bin.tar.gz) +* MacOS X: [leanote-mac-x86_64.v1.0-beta.2.bin.tar.gz](https://github.com/leanote/leanote/releases/download/1.0-beta/leanote-mac-x86_64.v1.0-beta.2.bin.tar.gz) + +ֱӼ[Leanote bin repository](https://github.com/leanote/leanote-bin) (Ƽ, ΪΪ°汾) + +### 3.2. װ MongodbDB + +Leanotegolang(ʹ[revel](https://revel.github.io/) [MongoDB](https://www.mongodb.org)ݿ), ҪȰװMongodb. + +װMongodbDB, ݸϸ鿴: [wiki](https://github.com/leanote/leanote/wiki/Install-Mongodb) + +### 3.3. ʼ + +MongodbDBʼ `[PATH_TO_LEANOTE]/mongodb_backup/leanote_install_data` + +``` +$> mongorestore -h localhost -d leanote --directoryperdb PATH_TO_LEANOTE/mongodb_backup/leanote_install_data +``` + +ʼݰû: + +``` +user2 username: admin, password: abc123 (Ա, Ҫ!) +user3 username: demo@leanote.com, password: demo@leanote.com (Ϊʹ) +``` + +### 3.4. + +޸ `[PATH_TO_LEANOTE]/conf/app.conf`. ѡ: + +``mongodb`` **!** + +```Shell +db.host=localhost +db.port=27017 +db.dbname=leanote +db.username= +db.password= +``` + +``app.secret`` **Ҫ** +޸һ, appԿ, ʹĬϵ, Ȼаȫ + +鿴 `app/app.conf` [revel ֲ](https://revel.github.io/) + +### 3.5. leanote + +``` +$> cd PATH_TO_LEANOTE/bin +$> sudo sh run.sh +``` + +## 4. ζleanoteжο + +鿴 [How-to-develop-leanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-%E5%A6%82%E4%BD%95%E5%BC%80%E5%8F%91leanote) + +## 5. +л [](https://github.com/leanote/leanote/graphs/contributors) Ĺ, leanoteǶ! + +## 6. + +ӭύ[pull requests](https://github.com/leanote/leanote/pulls) leanote. + +leanoteкܶ, ϲ, ӭһleanote. + +## ĵ +* [leanoteưϸװ̳](https://github.com/leanote/leanote/wiki/leanote%E4%BA%8C%E8%BF%9B%E5%88%B6%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) +* [leanoteϸװ̳](https://github.com/leanote/leanote/wiki/leanote%E5%BC%80%E5%8F%91%E7%89%88%E8%AF%A6%E7%BB%86%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B) +* [Leanote source leanoteԴ뵼](https://github.com/leanote/leanote/wiki/Leanote-source-leanoteԴ뵼) +* [leanote blog theme api(İ)](https://github.com/leanote/leanote/wiki/leanote-blog-theme-api) +* [How to develop leanote οleanote](https://github.com/leanote/leanote/wiki/How-to-develop-leanote-οleanote) + + +## +* [leanote ](http://bbs.leanote.com) +* QQȺ: 158716820 +* [leanote google group](https://groups.google.com/forum/#!forum/leanote) + +---------------------------------------------------------------- +[English](README_zh.md)