From ede161c54f1ac326fbfa0fa038876b78449ea856 Mon Sep 17 00:00:00 2001 From: Tan Kian-ting Date: Sun, 27 Aug 2023 12:29:31 +0800 Subject: [PATCH] modified the readme and remove the generated docs --- CHANGES | 2 ++ README.md | 24 +++++++++++++- docs/StringCodepointSplitter.html | 41 ------------------------ docs/index.html | 24 -------------- docs/index_attributes.html | 18 ----------- docs/index_class_types.html | 18 ----------- docs/index_classes.html | 18 ----------- docs/index_exceptions.html | 18 ----------- docs/index_extensions.html | 18 ----------- docs/index_methods.html | 18 ----------- docs/index_module_types.html | 18 ----------- docs/index_modules.html | 21 ------------- docs/index_types.html | 18 ----------- docs/index_values.html | 25 --------------- docs/style.css | 43 -------------------------- docs/type_StringCodepointSplitter.html | 11 ------- 16 files changed, 25 insertions(+), 310 deletions(-) create mode 100644 CHANGES delete mode 100644 docs/StringCodepointSplitter.html delete mode 100644 docs/index.html delete mode 100644 docs/index_attributes.html delete mode 100644 docs/index_class_types.html delete mode 100644 docs/index_classes.html delete mode 100644 docs/index_exceptions.html delete mode 100644 docs/index_extensions.html delete mode 100644 docs/index_methods.html delete mode 100644 docs/index_module_types.html delete mode 100644 docs/index_modules.html delete mode 100644 docs/index_types.html delete mode 100644 docs/index_values.html delete mode 100644 docs/style.css delete mode 100644 docs/type_StringCodepointSplitter.html diff --git a/CHANGES b/CHANGES new file mode 100644 index 0000000..4db36c9 --- /dev/null +++ b/CHANGES @@ -0,0 +1,2 @@ +## 0.0.1 + - 2023-08-27 : add `split_string_by_unicode_codepoint` initially \ No newline at end of file diff --git a/README.md b/README.md index 6841e65..06121e5 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,30 @@ Split a string to a list of strings of a character by the unicode codepoint. It requires module Uutf. -for documantations, see `docs` +## Dependencies + - OCaml >= 4.13 + - dune + - uutf + - fildlib +## Install + +``` +$ cd /path/to/stringCodepointSplitter + +$ dune build + +$ dune install + +``` + +## Generate Docs +``` +$ dune build @doc +``` + +Generated documentations will be in `/path/to/stringCodepointSplitter/_build/default/_doc` in +various formats, incl. html. ## Example ```OCaml diff --git a/docs/StringCodepointSplitter.html b/docs/StringCodepointSplitter.html deleted file mode 100644 index 5cfef1e..0000000 --- a/docs/StringCodepointSplitter.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - -StringCodepointSplitter - - -
 Up - 
-

Module StringCodepointSplitter

- -
module StringCodepointSplitter: sig .. end
-

The Module needs Uutf Module.

- -

It only contains split_string_by_unicode_codepoint, which splits an OCaml string str to a string list

- -
val split_string_by_unicode_codepoint : string -> string list
-
-

Split an OCaml string str to a string list

- -

Arguments

-
    -
  • str the string to be splitted. -
    • -
- -

Example

- -
let example= "m̄知 who you're." (*don't know who you are*) in
-
-List.map (fun x -> print_string (x ^ ", ")) (split_string_by_unicode_codepoint example);;
-  
-(*it will output : "m, ̄, 知,  , w, h, o,  , y, o, u, ', r, e, ., "*)
-
- diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 987b93e..0000000 --- a/docs/index.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - -
- -
- - - -
StringCodepointSplitter
- - diff --git a/docs/index_attributes.html b/docs/index_attributes.html deleted file mode 100644 index eff9c8e..0000000 --- a/docs/index_attributes.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of class attributes - - -
 Up - 
-

Index of class attributes

- -
- - diff --git a/docs/index_class_types.html b/docs/index_class_types.html deleted file mode 100644 index 69cfea9..0000000 --- a/docs/index_class_types.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of class types - - -
 Up - 
-

Index of class types

- -
- - diff --git a/docs/index_classes.html b/docs/index_classes.html deleted file mode 100644 index 33bf4b6..0000000 --- a/docs/index_classes.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of classes - - -
 Up - 
-

Index of classes

- -
- - diff --git a/docs/index_exceptions.html b/docs/index_exceptions.html deleted file mode 100644 index cf9e16b..0000000 --- a/docs/index_exceptions.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of exceptions - - -
 Up - 
-

Index of exceptions

- -
- - diff --git a/docs/index_extensions.html b/docs/index_extensions.html deleted file mode 100644 index 23ae9db..0000000 --- a/docs/index_extensions.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of extensions - - -
 Up - 
-

Index of extensions

- -
- - diff --git a/docs/index_methods.html b/docs/index_methods.html deleted file mode 100644 index ddfede4..0000000 --- a/docs/index_methods.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of class methods - - -
 Up - 
-

Index of class methods

- -
- - diff --git a/docs/index_module_types.html b/docs/index_module_types.html deleted file mode 100644 index 7a44842..0000000 --- a/docs/index_module_types.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of module types - - -
 Up - 
-

Index of module types

- -
- - diff --git a/docs/index_modules.html b/docs/index_modules.html deleted file mode 100644 index f33fc5e..0000000 --- a/docs/index_modules.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - -Index of modules - - -
 Up - 
-

Index of modules

- - - - -
S
StringCodepointSplitter
- - diff --git a/docs/index_types.html b/docs/index_types.html deleted file mode 100644 index 4ba29c5..0000000 --- a/docs/index_types.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -Index of types - - -
 Up - 
-

Index of types

- -
- - diff --git a/docs/index_values.html b/docs/index_values.html deleted file mode 100644 index cbc589b..0000000 --- a/docs/index_values.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - -Index of values - - -
 Up - 
-

Index of values

- - - - -
S
split_string_by_unicode_codepoint [StringCodepointSplitter]
-

Split an OCaml string str to a string list

- -
-
- - diff --git a/docs/style.css b/docs/style.css deleted file mode 100644 index 259bd49..0000000 --- a/docs/style.css +++ /dev/null @@ -1,43 +0,0 @@ -.keyword { font-weight : bold ; color : Red } -.keywordsign { color : #C04600 } -.comment { color : Green } -.constructor { color : Blue } -.type { color : #5C6585 } -.string { color : Maroon } -.warning { color : Red ; font-weight : bold } -.info { margin-left : 3em; margin-right: 3em } -.param_info { margin-top: 4px; margin-left : 3em; margin-right : 3em } -.code { color : #465F91 ; } -.typetable { border-style : hidden } -.paramstable { border-style : hidden ; padding: 5pt 5pt} -tr { background-color : White } -td.typefieldcomment { background-color : #FFFFFF ; font-size: smaller ;} -div.sig_block {margin-left: 2em} -*:target { background: yellow; } -body {font: 13px sans-serif; color: black; text-align: left; padding: 5px; margin: 0} -h1 { font-size : 20pt ; text-align: center; } -h2 { font-size : 20pt ; text-align: center; } -h3 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ;padding: 2px; } -h4 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90DDFF ;padding: 2px; } -h5 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90EDFF ;padding: 2px; } -h6 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90FDFF ;padding: 2px; } -div.h7 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ; padding: 2px; } -div.h8 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #E0FFFF ; padding: 2px; } -div.h9 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #F0FFFF ; padding: 2px; } -div.h10 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #FFFFFF ; padding: 2px; } -a {color: #416DFF; text-decoration: none} -a:hover {background-color: #ddd; text-decoration: underline} -pre { margin-bottom: 4px; font-family: monospace; } -pre.verbatim, pre.codepre { } -.indextable {border: 1px #ddd solid; border-collapse: collapse} -.indextable td, .indextable th {border: 1px #ddd solid; min-width: 80px} -.indextable td.module {background-color: #eee ; padding-left: 2px; padding-right: 2px} -.indextable td.module a {color: #4E6272; text-decoration: none; display: block; width: 100%} -.indextable td.module a:hover {text-decoration: underline; background-color: transparent} -.deprecated {color: #888; font-style: italic} -.indextable tr td div.info { margin-left: 2px; margin-right: 2px } -ul.indexlist { margin-left: 0; padding-left: 0;} -ul.indexlist li { list-style-type: none ; margin-left: 0; padding-left: 0; } -ul.info-attributes {list-style: none; margin: 0; padding: 0; } -div.info > p:first-child { margin-top:0; } -div.info-desc > p:first-child { margin-top:0; margin-bottom:0; } \ No newline at end of file diff --git a/docs/type_StringCodepointSplitter.html b/docs/type_StringCodepointSplitter.html deleted file mode 100644 index 2fadd25..0000000 --- a/docs/type_StringCodepointSplitter.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - -StringCodepointSplitter - - -sig end