mirrors/TidGi-Desktop
1
Fork 0
mirror of https://github.com/tiddly-gittly/TidGi-Desktop.git synced 2025-12-06 02:30:47 -08:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
林一二 2021-06-02 13:55:28 +08:00
parent 70fb66ce7b
commit 41abb8c969
1 changed files with 40 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -4,18 +4,29 @@
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [![GitHub Actions macOS Build Status](https://github.com/tiddly-gittly/TiddlyGit-Desktop/workflows/macOS/badge.svg)](https://github.com/tiddly-gittly/TiddlyGit-Desktop/actions?query=workflow%3AmacOS) | [![GitHub Actions Linux Build Status](https://github.com/tiddly-gittly/TiddlyGit-Desktop/workflows/Linux/badge.svg)](https://github.com/tiddly-gittly/TiddlyGit-Desktop/actions?query=workflow%3ALinux) | [![GitHub Actions Windows Build Status](https://github.com/tiddly-gittly/TiddlyGit-Desktop/workflows/Windows/badge.svg)](https://github.com/tiddly-gittly/TiddlyGit-Desktop/actions?query=workflow%3AWindows) |
**TiddlyGit** - Customizable personal knowledge-base with Github as unlimited storage and blogging platform.
**TiddlyGit** - Customizable personal knowledge-base with git as backup manager and blogging platform.
注意，正在重构成 TS，版本一段时间内不会更新，新版会修复很多问题。[refactor TS](https://github.com/tiddly-gittly/TiddlyGit-Desktop/projects/7)
**太记** - 可定制性极强的个人知识管理系统，使用 Git 作为备份管理器和博客平台。
Attention, It is in a process refactoring to ts, there won't be an update for a while. New version will fix various of things. [refactor TS](https://github.com/tiddly-gittly/TiddlyGit-Desktop/projects/7)
You can choose storage provider for your wiki workspace:
1. "Github" as unlimited storage and gh-pages blogging platform.
1. "Local" will create a local git repo for you, you can use [GithubDesktop](https://github.com/desktop/desktop) to sync manually.
1. "Gitlab" and "Gitee" is on the way
你可以选择你的 WIKI 工作区的存储服务提供商：
1. 「Github」是一个无限存储空间、可以用 GH-Pages 部署博客的平台。
1. 「本地」模式会创建一个本地仓库来备份你的 WIKI，你可以用 [GithubDesktop](https://github.com/desktop/desktop) 来手动同步内容到云端。
1. 「Gitlab」和「码云」还待支持，不过架子已经搭好了。
[![GitHub Releases](https://img.shields.io/github/downloads/tiddly-gittly/TiddlyGit-Desktop/latest/total?label=Download%20Latest%20Release&style=for-the-badge)](https://github.com/tiddly-gittly/TiddlyGit-Desktop/releases/latest)
For windows users (I'm personally using MacOS), I'm recently lacking time to fully test the Windows build, so there may be some bug in it, if you can help test and find some bug, please contact me github issue.
<details>
<summary>For mac users, since I haven't buy Apple developer key yet, so you have to entrust App to open it ◀</summary>
<summary>For mac users, since I haven't buy Apple developer key yet, so you have to entrust App to open it, click here to expand details.
Mac 使用者点击这里展开操作方法，我没钱买苹果开发者账号，所以你得手动信任这个应用◀</summary>
Click "Cancel" ↓
@ -37,19 +48,28 @@ Click "OK" ↓
## About TiddlyGit-Desktop 关于「太记-桌面版」
TiddlyGit is a cross-platform Note Taking & GTD & Fragment Knowledge Management desktop app powered by [nodejs-TiddlyWiki](https://github.com/Jermolene/TiddlyWiki5#installing-tiddlywiki-on-nodejs), it ship with a lot of tiddlywiki plugins from the [TiddlyWiki community](https://groups.google.com/forum/#!forum/tiddlywiki).
---
「太记」是一个跨平台的笔记软件、时间和任务管理工具、碎片化知识管理工具，此乃其桌面版。「太记」基于强大的 [NodeJS 版「太微（TiddlyWiki）」](https://github.com/Jermolene/TiddlyWiki5#installing-tiddlywiki-on-nodejs) 构建，并带上了大量来自[太微社区（TiddlyWiki community）](https://groups.google.com/forum/#!forum/tiddlywiki)的插件。
TiddlyGit is a cross-platform Note Taking & GTD & Fragment Knowledge Management desktop app powered by [nodejs-TiddlyWiki](https://github.com/Jermolene/TiddlyWiki5#installing-tiddlywiki-on-nodejs), it ship with a lot of tiddlywiki plugins from the [TiddlyWiki community](https://groups.google.com/forum/#!forum/tiddlywiki).
You can call it TG-Note, it is totally free and you own all your data. Code by the people, build for the people.
「太记」来自 TiddlyWiki 的译名「太微」，以及 TiddlyGit 首字母的谐音。当然你也可以直接叫它 TGNote，镰锤☭笔记。
---
「太记」是一个跨平台的笔记软件、时间和任务管理工具、碎片化知识管理工具，此乃其桌面版。「太记」基于强大的 [NodeJS 版「太微（TiddlyWiki）」](https://github.com/Jermolene/TiddlyWiki5#installing-tiddlywiki-on-nodejs) 构建，并带上了大量来自[太微社区（TiddlyWiki community）](https://groups.google.com/forum/#!forum/tiddlywiki)的插件。
「太记」来自 TiddlyWiki 的译名「太微」，以及 TiddlyGit 首字母的谐音。当然你也可以直接叫它 TGNote，镰锤 ☭ 笔记。
为什么把 TiddlyWiki 翻译成「太微」？因为受到 @pimgeek 的启发：TiddlyWiki 可以干很多细致轻量的工作，但也从不限制用法，可以无限组合叠加。故以其首字母音译为「太微」，TiddlyWiki 可以称为「太微笔记」「太微万能抽屉」「太微卡片盒」……
> 太微垣，三垣之一，按《步天歌》，太微垣為三垣的上垣。
> 太微垣又名天庭，是政府的意思，也是貴族及大臣們居住的地方。
---
### Screenshots 截图
![Screenshot of main-window](./docs/images/main-window.png)
![Screenshot of add-workspace](./docs/images/add-workspace.png)
![Screenshot of preference](./docs/images/preference.png)
@ -96,12 +116,19 @@ cd TiddlyGit-Desktop
# and open it in your favorite code editor and terminal app
# switch to the nodejs version same as electron used version, other wise you may get
# Error: The module '/Users/linonetwo/Desktop/repo/TiddlyGit-Desktop/node_modules/opencv4nodejs-prebuilt/build/Release/opencv4nodejs.node'
# was compiled against a different Node.js version using
# NODE_MODULE_VERSION 88. This version of Node.js requires
# NODE_MODULE_VERSION 93. Please try re-compiling or re-installing
# the module (for instance, using `npm rebuild` or `npm install`).
# See https://github.com/justadudewhohacks/opencv4nodejs/issues/401#issuecomment-463434713 if you still have problem rebuild opencv for @nut-tree/nut-js
nvm use
# install the dependencies
@ -109,12 +136,15 @@ nvm use
npm i
# Run development mode
# You can see webpack error messages in http://localhost:9000/
npm start
# Build for production
npm run package
```
### Publish
@ -130,3 +160,4 @@ After Github Action completed, you can open Releases to see the Draft release cr
The desktop app shell is based on [https://github.com/atomery/singlebox](atomery/singlebox) and [atomery/webcatalog](https://github.com/atomery/webcatalog), they provide lots of utils around website-generated-app, much powerful than generating app from website simply using Chrome. Also the independent developer @quanglam2807 behind these great tools helps me a lot when I develop TiddlyGit.
Current Icon is download from [iconsdb](https://www.iconsdb.com/custom-color/github-11-icon.html) under Creative Commons Attribution-NoDerivs 3.0 , if you are a designer, please feel free to contribute your ICON if you have a better idea.
```