towk/gdpm
1
0
Fork 0
mirror of https://github.com/davidallendj/gdpm.git synced 2025-12-20 03:27:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md to install on Arch Linux

Browse source
This commit is contained in:
David Allen 2024-08-28 23:36:25 -06:00
parent d50dbeb051
commit aebd86b70a
Signed by: towk
GPG key ID: 793B2924A49B3A3F
1 changed files with 32 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -7,24 +7,26 @@ GDPM is an attempt to make a simple, front-end, command-line, package manager de
\*GDPM has not been tested for Windows or Mac. \*GDPM has not been tested for Windows or Mac.
- [Quick Start](#quick-start) - [Godot Package Manager (GDPM)](#godot-package-manager-gdpm)
- [Rational](#rationale) - [Quick Start](#quick-start)
- [How It Works](#how-it-works) - [Rationale](#rationale)
- [Features](#features) - [How It Works](#how-it-works)
- [Building from Source](#building-from-source) - [Features](#features)
- [Installing with Package Managers](#installing-with-package-managers)
- [Building from Source](#building-from-source)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Macro Definitions](#macro-definitions) - [Macro Definitions](#macro-definitions)
- [API Documentation](#api-documentation) - [API Documentation](#api-documentation)
- [How to use the CLI](#how-to-use-the-cli) - [How to use the CLI](#how-to-use-the-cli)
- [Installing, Removing, Updating, and Listing](#installing-removing-updating-and-listing) - [Installing, Removing, Updating, and Listing](#installing-removing-updating-and-listing)
- [Searching](#searching) - [Searching](#searching)
- [Linking and Cloning](#linking-and-cloning) - [Linking and Cloning](#linking-and-cloning)
- [Cleaning Temporary Files](#cleaning-temporary-files) - [Cleaning Temporary Files](#cleaning-temporary-files)
- [Managing Remote Sources](#managing-remote-sources) - [Managing Remote Sources](#managing-remote-sources)
- [Managing Configuration Properties](#managing-configuration-properties) - [Managing Configuration Properties](#managing-configuration-properties)
- [Planned Features](#planned-features) - [Planned Features](#planned-features)
- [Known Issues](#known-issues) - [Known Issues](#known-issues)
- [License](#license) - [License](#license)
@ -106,6 +108,18 @@ The local database stores all the information sent by the Asset API with additio
* Parallel downloads using `libcurl`. * Parallel downloads using `libcurl`.
## Installing with Package Managers
Currently, `gdpm` can only be installed using `makepkg` on Arch Linux with plans of packaging for other distributions in the future.
```bash
git clone https://github.com/davidallendj/gdpm && cd gdpm/dist/archlinux
makepkg -si
```
This should build the static binary from source and then install it in `/usr/bin/gdpm`.
## Building from Source ## Building from Source
The project uses the CMake or Meson build system and has been tested with GCC and Clang on Arch/Manjaro Linux. CMake is preferred, but a `meson.build` script is provided and should work with some tweaking. Building on Windows or Mac has not been tested yet so it's not guaranteed to work. Compiling with CMake will build 2 executables, 3 shared libraries, and an archive library to link, while compiling with Meson only builds an executable that links with a shared library. The project uses the CMake or Meson build system and has been tested with GCC and Clang on Arch/Manjaro Linux. CMake is preferred, but a `meson.build` script is provided and should work with some tweaking. Building on Windows or Mac has not been tested yet so it's not guaranteed to work. Compiling with CMake will build 2 executables, 3 shared libraries, and an archive library to link, while compiling with Meson only builds an executable that links with a shared library.