Summary

• add a compact feature overview table near the top of the README
• link each row to the existing detailed section so the current screenshots and explanations stay intact
• keep the change docs-only and scoped to issue [Documentation] Provide an overview as table in the README #3180

Closes #3180

Testing

• 
  running 124 tests
  test assets::build_assets::acknowledgements::tests::test_append_to_acknowledgements_adds_newline_if_missing ... ok
  test assets::build_assets::acknowledgements::tests::test_normalize_license_text ... ok
  test assets::build_assets::acknowledgements::tests::test_normalize_license_text_with_windows_line_endings ... ok
  test assets::tests::syntax_detection_hidden_file_extensions ... ok
  test assets::tests::syntax_detection_for_symlinked_file ... ok
  test assets::tests::syntax_detection_well_defined_mapping_for_duplicate_extensions ... ok
  test assets::tests::syntax_detection_basic ... ok
  test config::default_config_should_highlight_no_lines ... ok
  test config::default_config_should_include_all_lines ... ok
  test config::get_pager_executable_default ... ok
  test config::get_pager_executable_empty_config ... ok
  test config::get_pager_executable_invalid_command ... ok
  test config::get_pager_executable_name_ignoring_arguments ... ok
  test config::get_pager_executable_name_ignoring_path ... ok
  test config::get_pager_executable_with_bat_pager ... ok
  test config::get_pager_executable_with_config_pager_builtin ... ok
  test config::get_pager_executable_with_config_pager_less ... ok
  test config::get_pager_executable_with_config_pager_more ... ok
  test config::get_pager_executable_with_pager_more_switches_to_less ... ok
  test input::basic ... ok
  test input::input_open_returns_initial_read_errors ... ok
  test input::non_zip_pk_prefix_is_not_treated_as_binary ... ok
  test input::unbuffered_eof_handling ... ok
  test input::unbuffered_returns_complete_lines ... ok
  test input::unbuffered_returns_partial_data ... ok
  test input::utf16le ... ok
  test input::utf16le_issue3367 ... ok
  test input::zip_magic_headers_are_treated_as_binary ... ok
  test less::test_parse_less_version_487 ... ok
  test less::test_parse_less_version_529 ... ok
  test less::test_parse_less_version_551 ... ok
  test less::test_parse_less_version_581_2 ... ok
  test less::test_parse_less_version_busybox ... ok
  test less::test_parse_less_version_invalid_utf_8 ... ok
  test less::test_parse_less_version_wrong_program ... ok
  test line_range::test_parse_context_edge_cases ... ok
  test line_range::test_parse_context_fail ... ok
  test line_range::test_parse_context_range ... ok
  test line_range::test_parse_context_single_line ... ok
  test line_range::test_parse_fail ... ok
  test line_range::test_parse_full ... ok
  test line_range::test_parse_minus_edge_cases_success ... ok
  test line_range::test_parse_minus_fail ... ok
  test line_range::test_parse_minus_success ... ok
  test line_range::test_parse_partial_max ... ok
  test line_range::test_parse_partial_min ... ok
  test assets::tests::syntax_detection_first_line ... ok
  test line_range::test_parse_partial_relative_negative_from_back ... ok
  test line_range::test_parse_plus ... ok
  test line_range::test_parse_plus_fail ... ok
  test line_range::test_parse_plus_overflow ... ok
  test line_range::test_parse_relative_negative_from_back_partial ... ok
  test line_range::test_parse_single ... ok
  test line_range::test_ranges_3_from_back_up_to_end ... ok
  test line_range::test_ranges_absolute_bound_and_offset ... ok
  test line_range::test_ranges_advanced ... ok
  test line_range::test_ranges_all ... ok
  test line_range::test_ranges_multiple_negative_from_back ... ok
  test line_range::test_ranges_multiple_negative_offsets_to_end ... ok
  test line_range::test_ranges_none ... ok
  test line_range::test_ranges_open_high ... ok
  test line_range::test_ranges_open_low ... ok
  test line_range::test_ranges_open_up_to_3_from_end ... ok
  test line_range::test_ranges_simple ... ok
  test preprocessor::test_sanitize_for_terminal_c0_controls ... ok
  test preprocessor::test_sanitize_for_terminal_idempotent_on_sanitized ... ok
  test preprocessor::test_sanitize_for_terminal_passthrough ... ok
  test preprocessor::test_strip_ansi ... ok
  test preprocessor::test_strip_overstrike ... ok
  test preprocessor::test_try_parse_utf8_char ... ok
  test style::test::style_component_list_default_builds_on_auto ... ok
  test style::test::style_component_list_expand_negates_subcomponents ... ok
  test style::test::style_component_list_parse ... ok
  test style::test::style_component_list_to_components ... ok
  test style::test::style_component_list_to_components_expands_subcomponents ... ok
  test style::test::style_component_list_to_components_precedence_merges_previous_lists ... ok
  test style::test::style_component_list_to_components_precedence_overrides_previous_lists ... ok
  test style::test::style_component_list_to_components_removes_negated ... ok
  test syntax_mapping::ignored_suffixes::external_suffixes ... ok
  test syntax_mapping::ignored_suffixes::internal_suffixes ... ok
  test syntax_mapping::tests::all_fixed_builtin_mappings_can_compile ... ok
  test syntax_mapping::tests::builtin_mappings_matcher_only_compile_once ... ok
  test assets::tests::syntax_detection_stdin_filename ... ok
  test syntax_mapping::tests::builtin_mappings_work ... ok
  test syntax_mapping::tests::case_sensitive_custom_mappings_work ... ok
  test syntax_mapping::tests::builtin_mappings_build_is_case_sensitive ... ok
  test syntax_mapping::tests::custom_mappings_precedence ... ok
  test syntax_mapping::tests::custom_mappings_override_builtin ... ok
  test theme::tests::choosing::chooses_dark_theme_if_dark_or_unknown ... ok
  test theme::tests::choosing::chooses_default_theme_if_unknown ... ok
  test theme::tests::choosing::chooses_light_theme_if_light ... ok
  test assets::tests::syntax_detection_is_case_insensitive ... ok
  test assets::tests::syntax_detection_first_line_with_utf8_bom ... ok
  test theme::tests::color_scheme_detection::called_for_always ... ok
  test theme::tests::color_scheme_detection::called_for_auto_if_should_detect ... ok
  test theme::tests::color_scheme_detection::not_called_for_auto_if_not_should_detect ... ok
  test theme::tests::color_scheme_detection::not_called_for_dark_or_light ... ok
  test theme::tests::default_theme::default_dark_if_requested_explicitly_through_theme ... ok
  test theme::tests::default_theme::default_dark_if_unable_to_detect_color_scheme ... ok
  test theme::tests::default_theme::varies_depending_on_color_scheme ... ok
  test theme::tests::precedence::detector_is_not_called_if_theme_is_present ... ok
  test theme::tests::precedence::theme_is_preferred_over_light_or_dark_themes ... ok
  test theme::tests::theme_preference::values_roundtrip_via_display ... ok
  test vscreen::tests::test_escape_sequence_iterator_iterates ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_iterates ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_csi ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_csi_thats_broken ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_csi_with_intermediates ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_csi_with_parameters ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_csi_with_parameters_and_intermediates ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_nf ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_nf_thats_broken ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_osc_thats_broken ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_osc_with_bel ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_osc_with_st ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_text ... ok
  test vscreen::tests::test_escape_sequence_offsets_iterator_parses_text_stops_at_esc ... ok
  test vscreen::tests::test_sgr_attributes_do_not_leak_into_wrong_field ... ok
  test syntax_mapping::tests::custom_mappings_work ... ok
  test assets::tests::syntax_detection_same_for_inputkinds ... ok
  test assets::tests::syntax_detection_invalid_utf8 ... ok
  test assets::tests::syntax_detection_for_symlinked_file_by_target_extension ... ok
  test assets::tests::syntax_detection_with_custom_mapping ... ok
  test assets::tests::syntax_detection_with_extension_mapping_to_unknown ... ok

test result: ok. 124 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.09s

running 11 tests
test config::empty ... ok
test config::comments ... ok
test config::multi_line ... ok
test config::multiple ... ok
test config::quotes ... ok
test config::single ... ok
test config::same_file_nonexistent ... ok
test config::same_file_identical_paths ... ok
test config::same_file_different_paths ... ok
test clap_app::verify_app ... ok
test config::same_file_via_symlink ... ok

test result: ok. 11 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

running 1 test
test all_themes_are_present ... ignored

test result: ok. 0 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.00s

running 1 test
test all_jobs_not_missing_any_jobs ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

running 231 tests
test ansi_hyperlink_emitted_when_wrapped ... ok
test ansi_highlight_underline ... ok
test accepts_no_custom_assets_arg ... ok
test acknowledgements ... ok
test alias_pager_disable_long_overrides_short ... ok
test basic ... ok
test ansi_passthrough_emit ... ok
test basic_io_cycle ... ok
test ansi_sgr_joins_attributes_when_wrapped ... ok
test bat_error_to_stderr ... ok
test basic_set_terminal_title ... ok
test binary_as_text_control_char_width ... ok
test bom_stripped_when_no_color_and_not_loop_through ... ok
test bom_not_stripped_in_loop_through_mode ... ok
test binary_as_text ... ok
test cache_help_shows_help_message ... ok
test can_print_file_named_cache ... ok
test cache_clear ... ok
test cache_build_blank ... ok
test can_print_file_named_cache_with_additional_argument ... ok
test concatenate_empty_between ... ok
test can_print_file_starting_with_cache ... ok
test alias_pager_disable ... ok
test concatenate ... ok
test ansi_highlight_json_keys ... ok
test ansi_sgr_emitted_when_wrapped ... ok
test concatenate_empty_both ... ok
test concatenate_empty_first ... ok
test concatenate_empty_first_and_last ... ok
test concatenate_single_line ... ok
test concatenate_empty_last ... ok
test config_location_from_bat_config_dir_variable ... ok
test concatenate_single_line_empty ... ok
test concatenate_stdin ... ok
test config_location_when_generating ... ok
test config_location_test ... ok
test disable_pager_if_disable_paging_flag_comes_after_paging ... ok
test diagnostic_sanity_check ... ok
test do_not_exit_directory ... ok
test disable_pager_if_pp_flag_comes_after_paging ... ok
test diagnostic_works_with_invalid_config ... ok
test does_not_print_unwanted_file_named_cache ... ok
test bom_stripped_when_colored_output ... ok
test config_read_arguments_from_file ... ok
test empty_file_cycle_is_ok ... ok
test empty_file_leads_to_empty_output_with_rule_enabled ... ok
test empty_file_leads_to_empty_output_with_grid_enabled ... ok
test env_var_bat_pager_value_bat ... ok
test enable_pager_if_disable_paging_flag_comes_before_paging ... ok
test env_var_pager_value_bat ... ok
test fail_directory ... ok
test fail_non_existing ... ok
test enable_pager_if_pp_flag_comes_before_paging ... ok
test env_var_bat_paging ... ok
test filename_multiple_err ... ok
test all_global_git_config_locations_syntax_mapping_work ... ok
test filename_multiple_ok ... ok
test diff_plain_preserves_change_markers ... ok
test filename_stdin ... ok
test diff_plain_does_not_show_grid_or_header ... ok
test do_not_detect_different_syntax_for_stdin_and_files ... ok
test grid_for_file_without_newline ... ok
test filename_stdin_binary ... ok
test first_file_cyclic_is_ok ... ok
test header_arg_overrides_env ... ok
test header_basic ... ok
test header_and_changes_only ... ok
test grid_overrides_rule ... ok
test header_binary ... ok
test header_env_basic ... ok
test header_default ... ok
test header_default_is_default ... ok
test fallback_syntax_does_not_override_explicit_language ... ok
test header_full_basic ... ok
test header_full_binary ... ok
test fallback_syntax_is_used_when_no_syntax_is_detected ... ok
test header_padding_rule ... ok
test header_full_padding ... ok
test header_narrow_terminal_with_multibyte_chars ... ok
test header_full_padding_rule ... ok
test header_padding ... ok
test header_very_narrow_terminal ... ok
test fallback_syntax_does_not_override_detected_syntax ... ok
test help_with_color_never ... ok
test header_zip_file_is_binary ... ok
test line_numbers ... ok
test line_numbers_from_cli_in_loop_through_mode ... ok
test line_range_2_3 ... ok
test line_range_context_around_range ... ok
test help_uses_valid_config ... ok
test line_range_context_around_single_line ... ok
test line_range_context_around_single_line_minimal ... ok
test line_range_context_negative_range ... ok
test line_range_context_at_end_of_file ... ok
test line_range_context_at_file_boundaries ... ok
test highlighting_is_skipped_on_long_lines ... ok
test line_range_context_non_numeric_range ... ok
test line_range_context_negative_single_line ... ok
test line_range_context_non_numeric_single_line ... ok
test line_range_context_very_large ... ok
test line_range_context_zero ... ok
test help_works_with_invalid_config ... ok
test line_range_first_two ... ok
test line_range_from_back_last_two ... ok
test line_range_last_3 ... ok
test line_range_from_back_last_two_single_line_eq_sep ... ok
test line_range_multiple ... ok
test line_range_from_back_last_two_single_line_no_sep ... ok
test line_range_up_to_2_from_back ... ok
test line_range_up_to_2_from_back_single_line_is_empty ... ok
test invalid_fallback_syntax_returns_error ... ok
test line_range_multiple_with_context ... ok
test list_themes_to_piped_output ... ok
test line_wrapping_when_auto ... ok
test list_themes_without_colors ... ok
test highlighting_independant_from_map_syntax_case ... ok
test long_help ... ok
test long_help_with_highlighting ... ok
test ignored_suffix_arg ... ok
test no_line_wrapping_when_set_to_never ... ok
test do_not_panic_regression_tests ... ok
test no_broken_osc_emit_with_line_wrapping ... ok
test no_pager_arg ... ok
test list_languages ... ok
test no_first_line_fallback_when_mapping_to_invalid_syntax ... ok
test no_line_wrapping_with_s_flag ... ok
test no_paging_arg ... ok
test no_strip_overstrike_for_plain_text ... ok
test no_wrapping_with_chop_long_lines ... ok
test numbers_honored_from_cli_when_preceeded_by_plain_in_loop_through_mode ... ok
test no_paging_short_arg ... ok
test list_themes_with_colors ... ok
test numbers_ignored_from_cli_when_followed_by_plain_in_loop_through_mode ... ok
test map_syntax_target_syntax_case_insensitive ... ok
test map_syntax_and_ignored_suffix_work_together ... ok
test pager_disable ... ok
test pager_arg_override_env_noconfig ... ok
test pager_failed_to_parse ... ok
test no_strip_overstrike_for_other_syntax ... ok
test pager_arg_override_env_withconfig ... ok
test pager_basic ... ok
test pager_basic_arg ... ok
test pager_env_bat_pager_override_config ... ok
test pager_env_pager_nooverride_config ... ok
test pager_value_bat ... ok
test pager_missing_warning ... ok
test piped_output_with_auto_style ... ok
test paging_does_not_override_simple_plain ... ok
test piped_output_with_implicit_auto_style ... ok
test piped_output_with_default_style_flag ... ok
test piped_output_with_line_numbers_style_flag ... ok
test piped_output_with_line_number_flag ... ok
test pager_more ... ok
test piped_output_with_line_numbers_with_header_grid_style_flag ... ok
test plain_mode_does_not_add_nonexisting_newline ... ok
test plain_with_sized_terminal_width ... ok
test quiet_empty_does_not_affect_non_empty_input ... ok
test quiet_empty_suppresses_output_on_empty_file ... ok
test quiet_empty_suppresses_output_on_empty_stdin ... ok
test pager_most_from_bat_pager_env_var ... ok
test short_help ... ok
test show_all_extends_tab_markers_to_next_tabstop ... ok
test show_all_extends_tab_markers_to_next_tabstop_width_8 ... ok
test pager_most_from_pager_arg ... ok
test show_all_mode ... ok
test show_all_shows_backspace_with_caret_notation ... ok
test show_all_with_caret_notation ... ok
test show_all_with_unicode ... ok
test pager_most_from_pager_env_var ... ok
test short_help_with_highlighting ... ok
test snip ... ok
test squeeze_blank ... ok
test squeeze_blank_line_numbers ... ok
test stdin ... ok
test squeeze_limit ... ok
test stdin_to_stdout_cycle ... ok
test strip_ansi_always_strips_ansi ... ok
test pager_most_with_arg ... ok
test squeeze_limit_line_numbers ... ok
test pager_overwrite ... ok
test plain_without_diff_still_works ... ok
test strip_ansi_does_not_affect_simple_printer ... ok
test strip_ansi_auto_does_not_strip_ansi_when_plain_text_by_option ... ok
test strip_ansi_never_does_not_strip_ansi ... ok
test strip_ansi_auto_does_not_strip_when_plain_text_by_filename ... ok
test strip_ansi_auto_strips_ansi_when_provided_syntax_by_option ... ok
test s_flag_respected_with_paging_always ... ok
test style_components_can_be_overidden ... ok
test strip_ansi_auto_strips_ansi_when_detected_syntax_by_filename ... ok
test style_components_can_be_removed ... ok
test style_components_will_merge ... ok
test tabs_4 ... ok
test style_components_will_merge_with_env_var ... ok
test strip_ansi_does_not_strip_when_show_nonprintable ... ok
test style_from_env_var_ignored_and_line_numbers_from_cli_in_loop_through_mode ... ok
test tabs_4_arg_overrides_env ... ok
test tabs_4_env_overrides_config ... ok
test tabs_8 ... ok
test tabs_4_wrapped ... ok
test tabs_4_arg_overrides_env_noconfig ... ok
test tabs_8_wrapped ... ok
test simple_plain_does_not_override_paging ... ok
test tabs_passthrough ... ok
test strip_overstrike_for_manpage_syntax ... ok
test tabs_numbers ... ok
test tabs_passthrough_wrapped ... ok
test terminal_width_arg_overrides_env ... ok
test terminal_width_env_var_is_respected ... ok
test theme_arg_overrides_env ... ok
test theme_arg_overrides_env_withconfig ... ok
test strip_overstrike_with_syntax_highlighting ... ok
test theme_dark_env_var_is_respected ... ok
test theme_light_env_var_is_respected ... ok
test unbuffered_flag_is_accepted ... ok
test theme_env_overrides_config ... ok
test unbuffered_mode_disables_line_numbers ... ok
test unbuffered_mode_plain_output ... ok
test unicode_wrap ... ok
test utf16le ... ok
test utf16be ... ok
test tcl_shebang_detection_expect ... ok
test word_wrap_breaks_at_word_boundaries ... ok
test version_works_with_invalid_config ... ok
test utf16 ... ok
test word_wrap_short_line_no_wrap ... ok
test word_wrap_with_line_numbers ... ok
test tcl_shebang_detection_wish ... ok
test tcl_shebang_detection_tclsh ... ok
test wrap_never_flag_respected_with_paging_always ... ok
test no_args_doesnt_break ... ok
test cache_build ... ok

test result: ok. 231 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 2.91s

running 1 test
test no_duplicate_extensions ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.03s

running 27 tests
test changes_grid_header ... ok
test changes_grid_numbers ... ok
test changes ... ok
test changes_grid_header_numbers_rule ... ok
test changes_grid_header_numbers ... ok
test changes_grid_header_rule ... ok
test changes_grid_rule ... ok
test changes_header_numbers ... ok
test changes_grid ... ok
test changes_header ... ok
test changes_numbers ... ok
test changes_rule ... ok
test grid_header ... ok
test changes_header_rule ... ok
test grid_header_numbers ... ok
test grid ... ok
test full ... ok
test grid_header_rule ... ok
test grid_numbers ... ok
test grid_rule ... ok
test header ... ok
test numbers ... ok
test header_numbers ... ok
test header_rule ... ok
test plain ... ok
test header_numbers_rule ... ok
test rule ... ok

test result: ok. 27 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.18s

running 2 tests
test config_overrides_system_config ... ignored
test use_systemwide_config ... ignored

test result: ok. 0 passed; 0 failed; 2 ignored; 0 measured; 0 filtered out; finished in 0.00s

running 1 test
test syntaxes ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.03s

running 5 tests
test src/vscreen.rs - vscreen::EscapeSequenceIterator (line 557) ... ignored
test src/vscreen.rs - vscreen::EscapeSequenceOffsetsIterator (line 353) ... ignored
test src/theme.rs - theme::ThemeName (line 125) ... ok
test src/theme.rs - theme::ThemePreference (line 61) ... ok
test src/lib.rs - (line 12) ... ok

test result: ok. 3 passed; 0 failed; 2 ignored; 0 measured; 0 filtered out; finished in 0.62s