You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-4Lines changed: 23 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1

2
2
> A buggy way to collaborate on text documents using the [Matrix](https://matrix.org) protocol. When it works, consider this the Matrix Console of collaboration!
3
3
4
-
Check it out at [matrix-notepad.kb1rd.net](https://matrix-notepad.kb1rd.net/) and come chat at [#matrix-collaboration:kb1rd.net](https://matrix.to/#/!lJKzxfcqmWpRzHxAsh:kb1rd.net?via=matrix.org)! I'd love to hear about what you think (and what issues you encounter)!
4
+
Check it out at [matrix-notepad.kb1rd.net](https://matrix-notepad.kb1rd.net/) and come chat at [#matrix-collaboration:kb1rd.net](https://matrix.to/#/#matrix-collaboration:kb1rd.net?via=kb1rd.net&via=matrix.org&via=matrix.geklautecloud.de)! I'd love to hear about what you think (and what issues you encounter)!
5
5
6
6
## Brief Roadmap
7
7
This is not in any particular order:
8
-
*[x] More or less working insertations
8
+
*[x] More or less working insertions
9
9
*[x] More or less working removals
10
10
*[ ] Conflict resolution
11
11
*[ ] Improved UI/UX (this will be incremental)
@@ -36,7 +36,7 @@ If you see error messages pop up or you encounter any bugs, **please** report it
36
36

37
37
38
38
## Contributing
39
-
Have a look at the [Wiki](https://github.com/KB1RD/matrix-notepad/wiki) if you're interested in contributing. The wiki also contains documentation about how this works.
39
+
Have a look at the [Wiki](https://github.com/KB1RD/matrix-notepad/wiki) if you're interested in contributing. I'd love the help! The wiki also contains documentation about how the algorithm, `logootish-js`, works internally as well as links to the JSDoc.
40
40
41
41
## Organization
42
42
Here is the directory structure
@@ -55,7 +55,6 @@ Here is the directory structure
55
55
*`test` -- A directory that I have reserved for unit testing. This would help **a lot** if I actually implemented it. *sigh*
56
56
57
57
## Build Setup
58
-
59
58
```bash
60
59
# install dependencies
61
60
$ yarn install
@@ -69,3 +68,23 @@ $ yarn run generate
69
68
# get webpack bundle statistics
70
69
$ yarn run stats
71
70
```
71
+
72
+
Also, if you want to debug the core algorithm, `logootish-js`, see https://github.com/KB1RD/logootish-js . If you want to test it with the Notepad, the `yarn link` setup process is as follows:
0 commit comments