canonical / canonical/core-initrd

Properly describe code structure in the documentation

Open
#41 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
18
Forks
33
PR merge metrics
No merged PRs in 30d

Description

We need to clearly describe code structure of this repository in the README.md or ARCHITECTURE.md files

Something like:

```
├── bin ---> Contains ubuntu-core-initramfs to build initrd.img
├── debian ---> debian directory to build deb package
├── factory ---> main skeleton of the initrd cpio archive
├── features
├── postinst.d
├── snakeoil
├── tests
├── vendor
├── COPYING
├── crypttab
├── grub.cfg
├── HACKING.md
├── initramfs.debug
├── LICENSE
├── README.md
└── spread.yaml

```

- bin ---> Contains ubuntu-core-initramfs to build initrd.img
- debian ---> debian directory to build deb package . Especially see "rules" file to see how it builds systemd and builds other relevant dependencies
- factory ---> main skeleton of the initrd cpio archive

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.