From 95aaedb4e32022ca57d2c057a372d15752df603a Mon Sep 17 00:00:00 2001 From: lleyton Date: Sat, 3 Dec 2022 15:54:24 -0800 Subject: [PATCH] Remove legacy docs --- docs/BUILDING.md | 49 ---------------------------------------- docs/CREATING.md | 59 ------------------------------------------------ 2 files changed, 108 deletions(-) delete mode 100644 docs/BUILDING.md delete mode 100644 docs/CREATING.md diff --git a/docs/BUILDING.md b/docs/BUILDING.md deleted file mode 100644 index 89092f074a..0000000000 --- a/docs/BUILDING.md +++ /dev/null @@ -1,49 +0,0 @@ -# Building packages - -To build packages from Fedora, you need to install `anda`, and also add the Terra repostories onto your system. - - -## Installing Terra repos - -Install the Terra repositories by adding it using DNF -``` -sudo dnf config-manager --add-repo https://github.com/terrapkg/subatomic-repos/raw/main/terra.repo -``` - -## Installing Andaman - -After adding the repositories above, install Andaman using DNF -``` -sudo dnf install anda -``` - -## Building packages - -To build packages using Andaman, you will need to use the `anda` mock configuration. - -Install the mock configurations -``` -sudo dnf install anda-mock-configs -``` - -Then specify the mock config everytime you build a package -``` -anda build -c anda-37-x86_64 $PROJECT -``` - -Substitute `37` with the version of Fedora you want to build for, same goes for the architecture. - -To list all available Andaman projects you can build, run: -``` -anda list -``` - -# Packaging SOP - -Project names should always be `pkg` inside the `anda` directory. -To build it, specify the path to the project then /pkg - -For example, to build the `dart` package, you would run: -``` -anda build -c anda-37-x86_64 anda/dart/pkg -``` diff --git a/docs/CREATING.md b/docs/CREATING.md deleted file mode 100644 index 294e2e31e4..0000000000 --- a/docs/CREATING.md +++ /dev/null @@ -1,59 +0,0 @@ -# Creating a new package - -## Prerequisites -- ensure the package doesn't exist in fedora repos -- avoid name coincide with other packages (including Fedora ones) - -## Create dir struct -1. Change directory to `anda/`. If the package is related to any categories, `cd` into the corresponding folder. - - For example, A Pantheon DE package goes into `anda/desktops/elementary/`. - - If the category is undecided, it's ok to put it in `anda/`. -2. Let's say we are adding a package called `tic-tac-toe`. We are going to make a new directory and add some required files: -```sh -cd anda/games -mkdir tic-tac-toe -cd tic-tac-toe -touch anda.hcl tic-tac-toe.spec -``` -3. Edit `anda.hcl`, which tells the [Andaman] toolchain how to build the package: -```hcl -project "pkg" { - rpm { - spec = "tic-tac-toe.spec" - sources = "." - } -} -``` -4. Edit the spec file `tic-tac-toe.spec`. It is an RPM spec file, and you are advised to read the documentation: - - This [RPM Packaging Guide] might help newbies with no prior experiences with RPM specs. - - This [Spec file format] docs goes into the details of the spec file format. -## Spec file -In general, you should state the name and the latest version of the package first. -1. Use `Release: %autorelease` unless you know what you are doing -2. The `License` field is required. If you don't know the license, check its repository page for the license file, or check other package repositories (such as the AUR) if it already exists there -3. State its dependencies with `Requires` -4. You will build the package. Add the `BulidRequires` packages -5. Add `Source0` or `Source1` or more. These preambles should link to a compressed file (preferably `tar`) and will be extracted during `%prep` -6. The source file will be automatically downloaded and extracted if you use `%autosetup -n ` inside `%prep`. Check `blackbox-terminal.spec` as an example -7. If it is not a tar archive, extract the file manually with a command. See `authy.spec` as an example (`unsquashfs`) -8. Inside `%build`, you might need to build the package. `%meson` and `%cmake` is supported. Check `blackbox-terminal` or `prismlauncher` - - if not, manually state the command -9. Copy, move, install files or add symlinks in `%install` -10. List out all the files to be included inside `%files` -11. Add `%changelog` (message preferrably "Initial Package") - -## Building -- Check if your new package builds. See [BUILDING.md] -```sh -anda build -c anda-37-x86_64 anda/games/tic-tac-toe/pkg -``` -- If it doesn't build, fix your spec file and try again - -## Finish -- Push and create a new PR - - -[Andaman]: https://github.com/FyraLabs/anda -[RPM Packaging Guide]: https://rpm-packaging-guide.github.io/ -[Spec file format]: https://rpm-software-management.github.io/rpm/manual/spec.html -[BUILDING.md]: BUILDING.md \ No newline at end of file