commit fe85c4c1abe3611a210f1df94bb9e04d894a97d0
parent 6cbd335dda435287297e408963cdbe6322ae6220
Author: krasjet
Date: 2020-07-14 10:16Z
fix line width
Diffstat:
M | LICENSE | | | 20 | ++++++++++++++++---- |
M | README.md | | | 37 | +++++++++++++++++++++++-------------- |
2 files changed, 39 insertions(+), 18 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,19 @@
-Copyright 2020 Krasjet
+Copyright 2020 krasjet
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,18 +1,25 @@
-# karasu
+karasu
+======
[](https://github.com/Krasjet/karasu/actions?query=workflow%3Abuild)
-[karasu](https://github.com/Krasjet/karasu) is a self-hosted remote
-communication system designed for math discussions. karasu is expected to be
-accompanied by [kamome](https://github.com/Krasjet/kamome), the front-end
-components, i.e. the editor and stylesheets for karasu.
+[karasu][karasu] is a self-hosted remote communication system designed for math
+discussions. karasu is expected to be accompanied by [kamome][kamome], the
+front-end components, i.e. the editor and stylesheets for karasu.
-Due to the limitations of GitHub's Markdown. Please see
-[**here**](https://krasjet.com/voice/karasu/) for detailed introduction.
+[karasu]: https://github.com/Krasjet/karasu
+[kamome]: https://github.com/Krasjet/kamome
-## Install
+Due to the limitations of the medium. Please see [**here**][karasu_intro] for
+detailed introduction.
+
+[karasu_intro]: https://krasjet.com/voice/karasu/
+
+Install
+-------
Docker compose should be able to take care of everything.
+
```
$ git clone --recursive https://github.com/Krasjet/karasu.git
$ cd karasu
@@ -20,13 +27,15 @@ $ cp .env.example .env
$ docker-compose up
```
-Note that the default fonts in [kamome](https://github.com/Krasjet/kamome) is a
-set of alternative free fonts. If you want to use the ones I'm currently using,
-you need to purchase/download the fonts listed
-[here](https://github.com/Krasjet/kamome/tree/master/static/fonts) and set the
-`USE_ALT_FONTS` option in `docker-compose.yml` to `false`.
+Note that the default fonts in [kamome][kamome] is a set of alternative free
+fonts. If you want to use the ones I'm currently using, you need to
+purchase/download the fonts listed [here][fonts] and set the `USE_ALT_FONTS`
+option in `docker-compose.yml` to `false`.
+
+[fonts]: https://github.com/Krasjet/kamome/tree/master/static/fonts
-## Screenshots
+Screenshots
+-----------
### Editor