Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add READMEs to Maven modules #2039

Merged
merged 2 commits into from
Dec 27, 2021
Merged

Add READMEs to Maven modules #2039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e96d55b
Add READMEs to Maven modules
Marcono1234 Dec 26, 2021
44252ec
Address feedback
Marcono1234 Dec 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions codegen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# gson-codegen

This Maven module contains the source code for automatically generating Gson type adapters.

:warning: This module is currently non-functional and might be removed in the future.
9 changes: 9 additions & 0 deletions examples/android-proguard-example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# android-proguard-example

Example Android project showing how to properly configure [ProGuard](https://www.guardsquare.com/proguard).
ProGuard is a tool for 'shrinking' and obfuscating compiled classes. It can rename methods and fields,
or remove them if they appear to be unused. This can cause issues for Gson which uses Java reflection to
access the fields of a class. It is necessary to configure ProGuard to make sure that Gson works correctly.

Also have a look at the [ProGuard manual](https://www.guardsquare.com/manual/configuration/usage#keepoverview)
for more details on how ProGuard can be configured.
6 changes: 6 additions & 0 deletions extras/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# extras

This Maven module contains the source code for supplementary Gson features which
are not included by default.

The artifacts created by this module are currently not deployed to Maven Central.
7 changes: 0 additions & 7 deletions gson/README
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions gson/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# gson
eamonnmcmanus marked this conversation as resolved.
Show resolved Hide resolved

This Maven module contains the Gson source code. The artifacts created by this module
are deployed to Maven Central under the coordinates `com.google.code.gson:gson`.
3 changes: 3 additions & 0 deletions metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# metrics

This Maven module contains the source code for running internal benchmark tests against Gson.
7 changes: 7 additions & 0 deletions proto/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# proto

This Maven module contains the source code for a JSON serializer and deserializer for
[Protocol Buffers (protobuf)](https://developers.google.com/protocol-buffers/docs/javatutorial)
messages.

The artifacts created by this module are currently not deployed to Maven Central.