diff options
| author | Ryo Nakamura <upa@haeena.net> | 2024-01-13 19:06:56 +0900 |
|---|---|---|
| committer | Ryo Nakamura <upa@haeena.net> | 2024-01-14 18:07:17 +0900 |
| commit | 1479607efe0be21e174bb977db5ad4f988547ffa (patch) | |
| tree | 459dbc32e1e75f31d84becc1f98d13c622304dcc /doc/README.md | |
| parent | 6f4038a48053da7074ad6bea429289329c0a9e3a (diff) | |
add manpage for mscp
doc/mscp.rst is generate from mscp.1 by make generate-mscp-rst.
README is also updateded to reference doc/mscp.rst.
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..d4bf747 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,11 @@ + +# Document + +The base file of documents is `mscp.1.in`. The manpage of mscp and +`doc/mscp.rst` are generated from `mscp.1.in`. + +When `mscp.1.in` is changed, update `doc/mscp.rst` by: + +1. `cd build` +2. `cmake ..` +3. `make update-mscp-rst`
\ No newline at end of file |