Skip to content

Commit 13a970f

Browse files
committed
Doc - improve the readme about contributions
1 parent d8fad28 commit 13a970f

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

Diff for: CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
![3Liz](icon.png) Contributions to the library
2+
==============================================
3+
4+
Any contributions are welcome to improve this library.
5+
You can make a pull request with your Javascript file.
6+
7+
* Do not forget to update the main readme in the root repository
8+
* We encourage you having a readme in the folder too with a screenshot or GIF showing the script. Like this [folder](./library/point_buffer_on_map)

Diff for: README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@
44
You can use those JavaScript scripts to enhance Lizmap Web Client.
55
Documentation is [here](https://docs.lizmap.com/next/en/publish/customization/javascript.html).
66

7-
You might have a `README.md` inside the directory with more information.
7+
You might have a `README.md` inside the directory with more information and a demo.
88

9-
* [Add documentation](./library/add_documentation)
10-
* [Add hamburger menu](./library/add_hamburger_menu)
11-
* [Add shortcuts](./library/add_shortcuts)
9+
* [Add documentation](./library/add_documentation) with buttons and a dock)
10+
* [Add hamburger menu](./library/add_hamburger_menu) for a better UX on a small screen
11+
* [Add keyboard shortcuts](./library/add_shortcuts)
1212
* [Attribute table column filter](./library/attribute_table_column_filter)
13-
* [Background selector](./library/background_selector)
13+
* [Background selector](./library/background_selector), like on Google Maps
1414
* [Dynamic form field visibility](./library/dynamic_form_field_visibility)
15-
* [Edit GPX](./library/edit_gpx)
15+
* [Edit GPX](./library/edit_gpx). Import/Export GPX
1616
* [Google Street View](./library/google_street_view)
1717
* [Group collapse](./library/group_collapse)
1818
* [Hide value popup](./library/hide_value_popup)
1919
* [IGN web services](./library/ign_web_services)
20-
* [Multiple atlas](./library/multipleatlas) Deprecated since LWC 3.4
20+
* [Multiple atlas](./library/multipleatlas). Deprecated since LWC 3.4
2121
* [Point buffer on map](./library/point_buffer_on_map) Display a buffer on the map
2222
* [Popup when opening the project with metadata information](./library/popup_metadata_info)
23-
* [Remove button](./library/remove_button)
23+
* [Remove button](./library/remove_button) to make the UI lighter and easier
2424
* [Simple filter](./library/simplefilter)
2525
* [Smart filter](./library/smartfilter)
26-
* [Snapping while editing](./library/snapping_while_editing) Deprecated since LWC 3.4
26+
* [Snapping while editing](./library/snapping_while_editing). Deprecated since LWC 3.4
2727
* [Translation](./library/translation) To provide a Lizmap project in many languages
2828
* [UI](./library/ui)
2929
* [WMTS direct access](./library/wmts_direct_access)

Diff for: library/point_buffer_on_map/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Buffer on the map
2+
13
* Add a button to enable a 1 km buffer centered on the map canvas
24

35
![demo](demo.gif)

0 commit comments

Comments
 (0)