Chromium Code Reviews| Index: appengine/findit/gae_libs/README.md |
| diff --git a/appengine/findit/gae_libs/README.md b/appengine/findit/gae_libs/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..98ecbd1534bd24b12c9f9901c58b45ffea3535a1 |
| --- /dev/null |
| +++ b/appengine/findit/gae_libs/README.md |
| @@ -0,0 +1,17 @@ |
| +# gae_libs |
|
lijeffrey
2016/11/14 07:16:04
Nit: I'm guessing gae stands for Google Appengine,
stgao
2016/11/14 23:30:51
Done.
|
| + |
| +This [gae\_libs](gae_libs) module is for shared code that depends on App Engine |
| +APIs, eg: an NDB model that supports keeping multiple versions of the same |
| +information like configuration. |
| + |
| +It also depends on the sibling [libs](libs) module, and provides gae wrappers |
| +for the code there, eg: a Gitiles client with data cached in memcache on App |
| +Engine. |
| + |
| +# How to use? |
| + |
| +Create symbolic links to both [gae\_libs](gae_libs) and [libs](libs) in the same |
| +containing directory, and ensure that the containing directory is in sys.path or |
| +PYTHONPATH. |
| + |
| +The usage would look like: `from gae_libs import API_MODULE_NAME` |