summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/huawei/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/huawei/README.md')
-rw-r--r--macros/latex/contrib/huawei/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/macros/latex/contrib/huawei/README.md b/macros/latex/contrib/huawei/README.md
new file mode 100644
index 0000000000..ddb9d7db34
--- /dev/null
+++ b/macros/latex/contrib/huawei/README.md
@@ -0,0 +1,29 @@
+Disclaimer: This is **NOT** a product of Huawei Technologies Co., Ltd.
+This package is created in order to help some people working
+with Huawei or inside Huawei to render some documents in LaTeX format.
+You are welcome to use it at your own risk.
+
+You can use this [`huawei.cls`](huawei.cls) LaTeX style just by copying it to some local
+directory and then mentioning it in the preamble of all your documents
+(on my laptop it's called `/code/huawei.cls`):
+
+```tex
+\documentclass[landscape]{/code/huawei}
+\author{Yegor Bugayenko}
+\title{An Interesting Document About Something}
+\begin{document}
+Hello, world!
+\end{document}
+```
+
+Find more examples in the [`samples/`](/samples) directory.
+
+If you need more formatting options,
+[submit an issue](https://github.com/cqfn/huawei-latex/issues),
+I'll implement them.
+
+If you want to contribute yourself, make a fork, then create a branch,
+then run `make` in the root directory.
+It should compile everything without errors. If not, submit an issue and wait.
+Otherwise, make your changes and then run `make` again. If the build is
+still clean, submit a pull request.