Skip to content

Commit 7525127

Browse files
committed
Version bump of dependencies, fix typos
1 parent 772dcee commit 7525127

File tree

19 files changed

+635
-9150
lines changed

19 files changed

+635
-9150
lines changed

.eslintrc.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,12 @@ module.exports = {
1717
plugins: [
1818
'prettier'
1919
],
20-
// add your custom rules here
2120
rules: {
22-
camelcase: 'off'
21+
// See https://github.com/KB1RD/matrix-notepad/wiki/Program-Organization
22+
camelcase: 'off',
23+
// I want the ability to order attributes as I see fit. For example, I
24+
// think it makes sense to put the 'title' attribute of a panel first
25+
// to improve readability.
26+
'vue/attributes-order': 'off'
2327
}
2428
}

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
![Matrix Notepad](static/logo/notepad%20logo.svg)
22
> 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!
33
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)!
55

66
## Brief Roadmap
77
This is not in any particular order:
8-
* [x] More or less working insertations
8+
* [x] More or less working insertions
99
* [x] More or less working removals
1010
* [ ] Conflict resolution
1111
* [ ] 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
3636
![Document Editing](static/document.png)
3737

3838
## 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.
4040

4141
## Organization
4242
Here is the directory structure
@@ -55,7 +55,6 @@ Here is the directory structure
5555
* `test` -- A directory that I have reserved for unit testing. This would help **a lot** if I actually implemented it. *sigh*
5656

5757
## Build Setup
58-
5958
``` bash
6059
# install dependencies
6160
$ yarn install
@@ -69,3 +68,23 @@ $ yarn run generate
6968
# get webpack bundle statistics
7069
$ yarn run stats
7170
```
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:
73+
``` bash
74+
# get logootish-js
75+
$ git clone https://github.com/KB1RD/logootish-js.git
76+
$ cd logootish-js
77+
78+
# install dependencies & build
79+
logootish-js$ yarn install
80+
logootish-js$ yarn run build
81+
82+
# link to yarn
83+
logootish-js$ yarn link
84+
85+
# switch to the notepad
86+
logootish-js$ cd ../matrix-notepad
87+
88+
# link logootish-js
89+
matrix-notepad$ yarn link logootish-js
90+
```

algorithms/logootish/.babelrc

Lines changed: 0 additions & 11 deletions
This file was deleted.

algorithms/logootish/.eslintrc.js

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)