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.

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

Restructure README #54

Merged
merged 3 commits into from
Oct 23, 2020
Merged

Restructure README #54

merged 3 commits into from
Oct 23, 2020

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Oct 23, 2020

Brings the action to the top, and adds the arguments.

Should we wrap it in <details>?

Example:

Expand to see all the arguments
Options:
-h, --help
      Display this help and exit.

Repository / Data
  -r, --repository <REPOSITORY>
      Set git repository to load data from.
  -b, --branch <BRANCH>
      Set git branch for repository.
  -t, --target <PATH_TO_BUILD>
      Set local folder or path inside repository for build.

Version/Image handling
  -v, --version <VERSION>
      Overwrite version/tag of build.
  -i, --image <IMAGE_NAME>
      Overwrite image name of build / support {arch}.
  --release <VERSION>
      Additional version information like for base images.
  --release-tag
      Use this as main tag.

Architecture
  --armhf
      Build for arm v6.
  --armv7
      Build for arm v7.
  --amd64
      Build for intel/amd 64bit.
  --aarch64
      Build for arm 64bit.
  --i386
      Build for intel/amd 32bit.
  --all
      Build all architecture.

Build handling
  --test
      Disable push to dockerhub.
  --no-latest
      Do not tag images as latest.
  --no-cache
      Disable cache for the build (from latest).
  --self-cache
      Use same tag as cache tag instead latest.
  --cache-tag
      Use a custom tag for the build cache.
  -d, --docker-hub <DOCKER_REPOSITORY>
      Set or overwrite the docker repository.
  --docker-hub-check
      Check if the version already exists before starting the build.
  --docker-user
      Username to login into docker with
  --docker-password
      Password to login into docker with
  --no-crossbuild-cleanup
      Don't cleanup the crosscompile feature (for multiple builds)

  Use the host docker socket if mapped into container:
      /var/run/docker.sock

Internals:
  --addon
      Default on. Run all things for an addon build.
  --generic <VERSION>
      Build based on the build.json
  --builder-wheels <PYTHON_TAG>
      Build the wheels builder for Home Assistant.
  --base <VERSION>
      Build our base images.
  --base-python <VERSION=ALPINE>
      Build our base python images.
  --base-raspbian <VERSION>
      Build our base raspbian images.
  --base-ubuntu <VERSION>
      Build our base ubuntu images.
  --base-debian <VERSION>
      Build our base debian images.
  --homeassisant-landingpage
      Build the landingpage for machines.
  --homeassistant-machine <VERSION=ALL,X,Y>
      Build the machine based image for a release.

@pvizeli
Copy link
Member

pvizeli commented Oct 23, 2020

Not sure. Maybe later?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@frenck
Copy link
Member

frenck commented Oct 23, 2020

Added some suggestions to make longer commands more readable and remove the $ to avoid copy paste errors (and make it consistent).

Co-authored-by: Franck Nijhof <git@frenck.dev>
@pvizeli pvizeli merged commit e6132ab into master Oct 23, 2020
@delete-merged-branch delete-merged-branch bot deleted the readme branch October 23, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants