Skip to content

Commit 2c19814

Browse files
doc: update user manual
1 parent 8a224f5 commit 2c19814

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

makespec/BUILDVERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1
1+
2

manual/llmanual.pdf

5.88 KB
Binary file not shown.

manual/llmanual.tex

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
\hypersetup{
1717
colorlinks=true,
1818
linkcolor=black,
19-
filecolor=black,
19+
filecolor=black,
2020
urlcolor=black,
2121
citecolor=black,
2222
}
@@ -31,8 +31,8 @@
3131
\pagecolor{white}
3232

3333
\title{\textbf{\huge LemonLime 用户手册}}
34-
\author{\texttt{浮尘ii*, iotang}}
35-
\date{}
34+
\author{\texttt{浮尘ii*, iotang, Coelacanthus}}
35+
%\date{}
3636

3737
\begin{document}
3838
\maketitle
@@ -94,13 +94,21 @@
9494

9595
也只能可惜 iotang 不够强了吧。\newline
9696

97+
2020 年,因为功能欠缺的 qmake,
98+
99+
Ceolacanthus 开始了把 LemonLime 从 QMake 迁移到 CMake 的路程。
100+
101+
又因为不想每次都编译,她开始改造 LemonLime 的 CI,
102+
103+
试图完成自动编译和打包,当然,这一切都还没完成。\newline
104+
97105
本篇用户手册是仿照 LemonPlus 的用户手册进行编写的。
98106

99107
\newpage
100108

101109
\section{Lemon 与开源意志}
102110

103-
LemonLime 使用 GPL v3 协议。也就是说,LemonLime 是自由软件。\newline
111+
LemonLime 使用 \href{https://www.gnu.org/licenses/gpl-3.0.html}{GPLv3} 协议。也就是说,LemonLime 是自由软件。\newline
104112

105113
自由软件是什么?为什么 LemonLime 选择成为自由软件?
106114

@@ -133,7 +141,7 @@
133141

134142
Lemon,以及它的后继者们,拥抱开源。
135143

136-
我们希望,Lemon 可以为全世界的 Oier 带来福祉。
144+
我们希望,Lemon 可以为全世界的 OIer 带来福祉。
137145

138146
让我们一起,把 Lemon 变得更好。
139147

@@ -146,6 +154,10 @@
146154
LemonLime 近乎完全兼容 LemonPlus,出问题的地方在子任务依赖(为了支持 0 分测试点的让步,不过这个问题将会被解决)。不过这个问题在使用对应平台重新测试后就可以自动解决。
147155

148156
LemonLime 完全兼容 Lemon。
157+
158+
LemonLime 主要使用 Qt 编写,目前使用的是 Qt5。
159+
160+
LemonLime 可以使用 \texttt{GCC}, \texttt{Clang} 和 \texttt{MSVC} 进行编译,但是如果在 Windows 下使用 \texttt{GCC} 编译则会遇到一些问题
149161

150162
\newpage
151163

@@ -166,18 +178,18 @@
166178
不过如果你获得了源码,可以通过 QtCreator 来编译 LemonLime。
167179

168180
\subsubsection{Linux}
169-
181+
170182
这里以 Manjaro 为例,毕竟 Linux 安装时几乎只有命令名字的区别。
171183

172184
更多的系统请到 README.md 查看。
173185

174186
首先你得安装一些依赖。
175187

176188
\begin{lstlisting}[language=bash,frame=shadowbox,basicstyle=\ttfamily]
177-
sudo pacman -S gcc make qt5-base
189+
sudo pacman -S gcc ninja qt5-base cmake
178190
\end{lstlisting}
179191

180-
注意 Manjaro 的 gcc 包含了 g++。
192+
注意 Manjaro 的 gcc 包含了 \texttt{g++}
181193

182194
然后用某种途径获得源代码。比如使用 git:
183195

@@ -188,18 +200,25 @@
188200
进入源代码的目录。
189201

190202
\begin{lstlisting}[language=bash,frame=shadowbox,basicstyle=\ttfamily]
191-
cd 源代码的目录
203+
cd <源代码的目录>
192204
\end{lstlisting}
193205

194206
然后依次执行:
195207

196208
\begin{lstlisting}[language=bash,frame=shadowbox,basicstyle=\ttfamily]
197209
g++ watcher_unix.cpp -o watcher_unix -O2
198-
qmake lemon.pro
199-
make
210+
cmake -DCMAKE_BUILD_TYPE=Release -GNinja .
211+
cmake --build . --parallel $(nproc)
200212
\end{lstlisting}
201213

202214
获得可执行文件 lemon。打开 lemon 就可以运行 LemonLime 了。
215+
216+
也可以执行
217+
218+
\begin{lstlisting}[language=bash,frame=shadowbox,basicstyle=\ttfamily]
219+
cmake --install .
220+
\end{lstlisting}
221+
将其安装到系统中,默认安装位置位于 \verb|\usr\local|
203222

204223
\newpage
205224

@@ -751,4 +770,4 @@
751770

752771
\newpage
753772

754-
\end{document}
773+
\end{document}

0 commit comments

Comments
 (0)