Add readme

Author: TwIStOy

README.md

@@ -0,0 +1,122 @@
+# LuaSnip Snippets
+
+A collection of snippets for various programming language. Some snippets are
+highly inspired by Jetbrain's IDEs.
+
+## Installation
+
+```lua
+{
+  "TwIStOy/luasnip-snippets",
+  dependencies = { "L3MON4D3/LuaSnip" },
+  event = { "InsertEnter" },
+  config = function()
+    -- register all snippets into LuaSnip
+    require("luasnip-snippets").setup()
+  end
+}
+```
+
+`autosnippet` feature should be enabled in `LuaSnip`.
+
+```lua
+local ls = require('luasnip')
+ls.setup({
+  enable_autosnippets = true,
+})
+```
+
+## Snippets
+
+Snippets which trigger ends with "!" are `autosnippet`.
+
+<details>
+<summary>Cpp</summary>
+
+#### Normal Snippets
+
+| Trig    | Desc                                                                                             | Context  |
+|:-------:|--------------------------------------------------------------------------------------------------|:--------:|
+| `ctor!` | Expand to default constructor                                                                    | In Class |
+| `dtor!` | Expand to default destructor                                                                     | In Class |
+| `cc!`   | Expand to default copy constructor                                                               | In Class |
+| `mv!`   | Expand to default move constructor                                                               | In Class |
+| `ncc!`  | Expand to delete copy constructor                                                                | In Class |
+| `nmv!`  | Expand to delete move constructor                                                                | In Class |
+| `ncm!`  | Expand to delete copy and move constructor                                                       | In Class |
+| `fn`    | Expand to lambda function in argument list or function body, otherwise expand to normal function | All      |
+
+#### Postfix Snippets
+
+```scheme
+[
+  (identifier)
+  (field_identifier)
+] @indent
+
+[
+  (call_expression)
+  (identifier)
+  (template_function)
+  (subscript_expression)
+  (field_expression)
+  (user_defined_literal)
+] @any_expr
+```
+
+|  Trig  | Desc (placehoder: `?`)                                         | Expr before cursor |
+|:------:|----------------------------------------------------------------|:------------------:|
+|  `.be` | Expand to begin and end exprs                                  |     `any_expr`     |
+|  `.mv` | Wraps with `std::move(?)`                                      |     `any_expr`     |
+| `.fwd` | Wraps with `std::forward<decltype(?)>(?)`                      |     `any_expr`     |
+| `.val` | Wraps with `std::declval<?>()`                                 |     `any_expr`     |
+|  `.dt` | Wraps with `decltype(?)`                                       |     `any_expr`     |
+|  `.uu` | Wraps with `(void)?`                                           |     `any_expr`     |
+|  `.ts` | Switch indent's coding style between CamelCase and snake_case. |      `indent`      |
+|  `.sc` | Wraps with `static_cast<>(?)`                                  |     `any_expr`     |
+
+</details>
+
+<details>
+<summary>Rust</summary>
+
+#### Postfix Snippets
+
+```scheme
+[
+  (struct_expression)
+  (call_expression)
+  (identifier)
+  (field_expression)
+] @expr
+
+[
+  (struct_expression)
+  (call_expression)
+  (identifier)
+  (field_expression)
+  
+  (generic_type)
+  (scoped_type_identifier)
+  (reference_type)
+] @expr_or_type
+```
+
+|    Trig    | Desc (placehoder: `?`)                                     | Expr before cursor |
+|:----------:|------------------------------------------------------------|:------------------:|
+|    `.rc`   | Wraps with `Rc::new(?)` if expr, `Rc<?>` if type           |   `expr_or_type`   |
+|   `.arc`   | Wraps with `Arc::new(?)` if expr, `Arc<?>` if type         |   `expr_or_type`   |
+|   `.box`   | Wraps with `Box::new(?)` if expr, `Box<?>` if type         |   `expr_or_type`   |
+|    `.mu`   | Wraps with `Mutex::new(?)` if expr, `Mutex<?>` if type     |   `expr_or_type`   |
+|    `.rw`   | Wraps with `RwLock::new(?)` if expr, `RwLock<?>` if type   |   `expr_or_type`   |
+|   `.cell`  | Wraps with `Cell::new(?)` if expr, `Cell<?>` if type       |   `expr_or_type`   |
+| `.refcell` | Wraps with `RefCell::new(?)` if expr, `RefCell<?>` if type |   `expr_or_type`   |
+|   `.ref`   | Wraps with `&?`                                            |       `expr`       |
+|   `.refm`  | Wraps with `&mut ?`                                        |       `expr`       |
+|    `.ok`   | Wraps with `Ok(?)`                                         |       `expr`       |
+|   `.err`   | Wraps with `Err(?)`                                        |       `expr`       |
+|   `.some`  | Wraps with `Some(?)`                                       |       `expr`       |
+| `.println` | Wraps with `println!("{:?}", ?)`                           |       `expr`       |
+
+</details>
+