#+title: Readme

* Examples
** A basic menu
#+begin_html
<a href="./example_menu.rs">
    <img src="./tapes/example_menu.gif" style="width: 60%;" />
</a>
#+end_html
** Enum matching
Using a ~to_string()~ and a ~from_string()~ function and an enum to simplify a match statement on the user's input.

#+begin_html
<a href="./enum_matching_results.rs">
    <img src="./tapes/enum_matching_results.gif" style="width: 60%;" />
</a>
#+end_html
** Hidden items
You can make some items not show up by default, and only appear in search results!

*Please Note:* The below example shows a known bug where the number of lines to clear is calculated imporperly for smaller terminal windows.
#+begin_html
<a href="./hidden_items.rs">
    <img src="./tapes/hidden_items.gif" style="width: 60%;" />
</a>
#+end_html
** Manually created menu
You can make a menu without using any macros, but it is much more wordy. Good for LoC statistics though!
#+begin_html
<a href="./manual_menu.rs">
    <img src="./tapes/manual_menu.gif" style="width: 60%;" />
</a>
#+end_html
** Sub Menus
Although sub menu's are not a feature of Cartographer, they are easily implemented.
#+begin_html
<a href="./sub_menus.rs">
    <img src="./tapes/sub_menus.gif" style="width: 60%;" />
</a>
#+end_html