1# Gigabyte Ampere Cuttlefish Installer 2 3This repo contains the scripts to generate live Debian installer for 4cuttlefish for Gigabyte Ampere server. 5 6## Download built image 7 8The built images can be found on https://artifacts.codelinaro.org/ui/native/linaro-372-googlelt-gigabyte-ampere-cuttlefish-installer/gigabyte-ampere-cuttlefish-installer 9 10The latest image are always put into https://artifacts.codelinaro.org/ui/native/linaro-372-googlelt-gigabyte-ampere-cuttlefish-installer/gigabyte-ampere-cuttlefish-installer/latest/ 11 12## Scripts 13 14 * build_cf_packages.sh: 15 We use this script to build cuttlefish-common packages. 16 Please use "pbuilder-dist stable arm64 create" to create a 17 chroot environment before running this script. 18 And update the chroot environment periodically by 19 "pbuilder-dist stable arm64 update". 20 * kernel_build_deb.sh: 21 * Build AOSP kernel to Debian packages. 22 * The source can be downloaded by kernel_download.sh 23 * kernel_dependencies.sh install the build dependencies that is needed 24 by kernel_build_deb.sh 25 * addpreseed.sh: 26 * To run this script. Users have to downmiad mini.iso first. 27 https://deb.debian.org/debian/dists/bookworm/main/installer-arm64/current/images/netboot/mini.iso 28 * This script will add preseed to the mini.iso to make it a live 29 installer for Gigabyte Ampere server. 30 31## Integrate with your tools 32 33- [ ] [Set up project integrations](https://git.codelinaro.org/linaro/googlelt/gigabyte-ampere-cuttlefish-installer/-/settings/integrations) 34 35## Collaborate with your team 36 37- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) 38- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) 39- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) 40- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) 41- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) 42 43## Test and Deploy 44 45Use the built-in continuous integration in GitLab. 46 47- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) 48- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) 49- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) 50- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) 51- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) 52 53*** 54 55# Editing this README 56 57When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. 58 59## Suggestions for a good README 60Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. 61 62## Name 63Choose a self-explaining name for your project. 64 65## Description 66Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. 67 68## Badges 69On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. 70 71## Visuals 72Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. 73 74## Installation 75Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. 76 77## Usage 78Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. 79 80## Support 81Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. 82 83## Roadmap 84If you have ideas for releases in the future, it is a good idea to list them in the README. 85 86## Contributing 87State if you are open to contributions and what your requirements are for accepting them. 88 89For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. 90 91You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. 92 93## Authors and acknowledgment 94Show your appreciation to those who have contributed to the project. 95 96## License 97For open source projects, say how it is licensed. 98 99## Project status 100If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. 101