summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/xreview/README
blob: a8ead075a517e9a1d0aff3703c68052c6b9baa01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
+-----------------------------------------------------------------------+
|                                                                       |
|              _______  _______          _________ _______              |
|    |\     /|(  ____ )(  ____ \|\     /|\__   __/(  ____ \|\     /|    |
|    ( \   / )| (    )|| (    \/| )   ( |   ) (   | (    \/| )   ( |    |
|     \ (_) / | (____)|| (__    | |   | |   | |   | (__    | | _ | |    |
|      ) _ (  |     __)|  __)   ( (   ) )   | |   |  __)   | |( )| |    |
|     / ( ) \ | (\ (   | (       \ \_/ /    | |   | (      | || || |    |
|    ( /   \ )| ) \ \__| (____/\  \   /  ___) (___| (____/\| () () |    |
|    |/     \||/   \__/(_______/   \_/   \_______/(_______/(_______)    |
|                                                                       |
|                                                                       |
|                  Reviewing LaTeX document made easy                   |
|                                                                       |
|                  by Lorenzo Peri - lp586@cam.ac.uk                    |
|                                                                       |
+-----------------------------------------------------------------------+

DESCRIPTION
===========

This package provides a simple way to review LaTeX documents. It allows to higlight and/or hide changes to a document, and to add comments to the text. This will help you to keep track of the changes you make to a document, and to easily spot the changes made by others, while always having the option of toggling a clean version of the document.

This package also offers a way to include comments in the text, which can be toggled on and off. This is useful for adding notes to the text, or for leaving comments to other authors.

AUTHOR
======

The package is maintained by Lorenzo Peri (https://github.com/LorenzoPeri17). The repository is available at https://github.com/LorenzoPeri17/xreview-latex.

LICENSE
=======

MIT License

Copyright (c) 2024 Lorenzo Peri

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 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.