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

Jump to bottom

Fix pip license error + add pip install command to readme #1419

Merged
merged 2 commits into from Aug 31, 2021
Merged

Fix pip license error + add pip install command to readme #1419

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
ba65a73
fix pip license error, add pip install to readme
janosh Aug 28, 2021
45fed61
fix warning: the 'license_file' option is deprecated, use 'license_fi…
janosh Aug 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
View file
Open in desktop
@@ -1,23 +1,46 @@
GAM is a command line tool for Google Workspace (fka G Suite) Administrators to manage domain and user settings quickly and easily.

![Build Status](https://github.com/jay0lee/GAM/workflows/Build%20and%20test%20GAM/badge.svg)

# Quick Start

## Linux / MacOS

Open a terminal and run:
```

```sh
bash <(curl -s -S -L https://git.io/install-gam)
```

this will download GAM, install it and start setup.

To install with `pip`, run

```sh
pip install git+https://github.com/jay0lee/GAM.git#subdirectory=src
```

This will only download and install GAM. To start setup, simply invoke the `gam` CLI.

## Windows

Download the MSI Installer from the [GitHub Releases] page. Install the MSI and you'll be prompted to setup GAM.

# Documentation

The GAM documentation is hosted in the [GitHub Wiki]

# Mailing List / Discussion group

The GAM mailing list / discussion group is hosted on [Google Groups]. You can join the list and interact via email, or just post from the web itself.

# Chat Room

There is a public chat room hosted in Google Chat. [Instructions to join](https://git.io/gam-chat).

# Author
GAM is maintained by <a href="mailto:jay0lee@gmail.com">Jay Lee</a>. Please direct "how do I?" questions to [Google Groups].

GAM is maintained by [Jay Lee](mailto:jay0lee@gmail.com). Please direct "how do I?" questions to [Google Groups].

[GAM release]: https://git.io/gamreleases
[GitHub Releases]: https://github.com/jay0lee/GAM/releases
Expand Down
2 changes: 1 addition & 1 deletion src/setup.cfg
View file
Open in desktop
Expand Up @@ -8,7 +8,7 @@ url = https://github.com/jay0lee/GAM
author = Jay Lee
author_email = jay0lee@gmail.com
license = Apache
license_file = src/license.rtf
license_files = LICENSE
keywords = google, oauth2, gsuite, google-apps, google-admin-sdk, google-drive, google-cloud, google-calendar, gam, google-api, oauth2-client, google-workspace
classifiers =
Programming Language :: Python :: 3
Expand Down