mirrors/TidGi-Desktop
1
Fork 0
mirror of https://github.com/tiddly-gittly/TidGi-Desktop.git synced 2026-04-18 03:21:50 -07:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
lin onetwo 2020-08-09 12:59:49 +08:00 • committed by GitHub
parent d61ea33684
commit 5d9f8ead1d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -31,10 +31,10 @@ Because Github is one of the best free civil level [BaaS](https://www.alibabaclo
Main reasons:
1. NodeJS version of TiddlyWiki have seamless auto-save experience, which is taking the advantage of SyncAdaptor instead of Syncer
1. We can have separated tiddler files, which can be modified by hand, or by other programs (e.g. VSCode with [VSCode-TW5-Syntax](https://github.com/joshuafontany/VSCode-TW5-Syntax))
1. Though TiddlyDesktop can load wiki folder generated by nodejs-TiddlyWiki, it can't backup that folder to the Github easily
1. With the electron as a shell, I can use `fs`, `git` and many other nodejs things within TiddlyWiki, which greatly extend the hackability.
1. NodeJS version of TiddlyWiki have seamless auto-save experience, which is taking the advantage of SyncAdaptor instead of Saver, TG have better support for NodeJS wiki
1. Using NodeJS wiki, We can have separated tiddler files, which can be modified by hand, or by other programs (e.g. VSCode with [VSCode-TW5-Syntax](https://github.com/joshuafontany/VSCode-TW5-Syntax))
1. Though TiddlyDesktop can load wiki folder generated by nodejs-TiddlyWiki, it can't backup that folder to the Github easily like TG does
1. With the electron as a shell, I can use `fs`, `git` and many other nodejs things within TiddlyWiki, which greatly extend the hackability, which is the reason why I choose TiddlyWiki as my daily KM tool
### Download
@ -55,10 +55,6 @@ Explanation of our code can be found in the [Wiki](https://github.com/tiddly-git
# First, clone the project:
git clone https://github.com/YOUR_ACCOUNT/TiddlyGit-Desktop.git
cd TiddlyGit-Desktop
# And initialize the submodule of TW-Bob
# I have already add it via git submodule add git@github.com:OokTech/TW5-Bob.git template/wiki/plugins/OokTech/Bob
# See https://git-scm.com/book/en/v2/Git-Tools-Submodules for meaning of following command
git submodule update --init --recursive
# Or maybe you are just using Github Desktop
# or GitKraken to clone this repo,
# and open it in your favorite code editor and terminal app
@ -77,6 +73,12 @@ npm run dist
```
### Publish
Add a tag like `vx.x.x` to a commit, and push it to the origin, Github will start building App for all three platforms.
After Github Action completed, you can open Releases to see the Draft release created by Github, add some comment and publish it.
</details>
## Credits