Skip to content

Commit

Permalink
Update changelogs and README and get ready for v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviermaridat committed May 25, 2022
1 parent 311e8b6 commit 7051634
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 16 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ release*
!test/update/*.lock
.tags
commit-*
*.deb
resources/*/DEBIAN
resources/*/usr
2 changes: 1 addition & 1 deletion PKGBUILD
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Maintainer: Olivier Maridat (Fylhan)

pkgname=qompoter
pkgver=0.5.0-RC1
pkgver=0.5.0
pkgrel=1
pkgdesc="Dependency manager for Qt / C++"
arch=('any')
Expand Down
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Installation

Qompoter requires Bash, Git, sed. Other tools like rsync, curl (or wget) and tar (or zip) may be useful for some advanced cases.

It works on Linux and Windows (using [Git bash](https://git-scm.com/)).
It works on Linux, including Busibox Linux based system like Alpine, and Windows (using [Git bash](https://git-scm.com/)).

It also works on MacOS, but requires additional packages to be installed with Homebrew (https://brew.sh/): `brew install gnu-sed && brew install coreutils`, then make sure to add these to your path, in order to use GNU sed and GNU date instead of the MacOS version:

Expand All @@ -43,7 +43,7 @@ It should also work on FreeBSD and more widely on Windows (Cygwin or Mysys comma
```bash
$ npm install -g qompoter
$ qompoter --version
Qompoter v0.4.0
Qompoter v0.5.0
Dependency manager for C++/Qt by Fylhan
```

Expand All @@ -52,21 +52,25 @@ Dependency manager for C++/Qt by Fylhan
Download it from Github and move it to a place accessible in the `PATH`:

```bash
$ wget https://github.com/Fylhan/qompoter/releases/download/v0.4.0/qompoter.sh -O qompoter.sh && sudo mv qompoter.sh /usr/bin/qompoter
$ wget https://github.com/Fylhan/qompoter/releases/download/v0.5.0/qompoter.sh -O qompoter.sh && sudo mv qompoter.sh /usr/bin/qompoter
$ qompoter --version
Qompoter v0.4.0
Qompoter v0.5.0
Dependency manager for C++/Qt by Fylhan
```

The MD5 sum of the v0.4.0 version is `272de8c30bb940507e390dd9e90eb5eb`.
The MD5 sum of the v0.5.0 version is `5c397cec3e4aff2df599a0dff08e2f74`.

To enable autocompletion, download the script and source it in your `~/.bashrc` file:

```bash
wget https://github.com/Fylhan/qompoter/releases/download/v0.4.0/qompoter_bash_completion.sh -O qompoter_bash_completion.sh && sudo mv qompoter_bash_completion.sh /usr/share/bash-completion/completions/qompoter
wget https://github.com/Fylhan/qompoter/releases/download/v0.5.0/qompoter_bash_completion.sh -O qompoter_bash_completion.sh && sudo mv qompoter_bash_completion.sh /usr/share/bash-completion/completions/qompoter
echo "test [ -f /usr/share/bash-completion/completions/qompoter ]; source /usr/share/bash-completion/completions/qompoter" >> ~/.bashrc
```

### Using Debian package (beta)

A Debian package can be generated using the script available in `resources/create-deb-package.sh`. Please share feedback!

Getting Started
-------------

Expand Down Expand Up @@ -100,7 +104,7 @@ In your project, create a qompoter.json file:
Then, download and install dependencies listed in your `qompoter.json` using:

```bash
qompoter install
qompoter update
```

*For more information about the command line options, use `qompoter --help` or check the [online help](docs/Command-line.md).*
Expand All @@ -114,9 +118,16 @@ include(vendor/vendor.pri)

Let's start coding!

During development, if you want to change / upgrade the version of an existing package, add or remove packages: update the `qompoter.json` file accordingly and run again `qompoter install`.
During development, if you want to change / upgrade the version of an existing package, add or remove packages: update the `qompoter.json` file accordingly and run again `qompoter update`.

If you reached a milestone of your project and wanted to provide a backup of your project's dependencies, run `qompoter export` to create an archive file of the `vendor` directory, or `qompoter export --repo <path to a directory>` to create a Qompotist-fs repository on which you can run `qompoter update`. You may want to use `qompoter inspect` before to check you did not modified manually any packages in the `vendor` directory.

Important change between Qompoter 0.4 and 0.5
-------------

The `qompoter update` has been introduced and is identical to the <0.4 `qompoter install` action: take the `qompoter.json`, download dependencies and generate a `qompoter.lock` file listing the downloaded versions.

If you reached a milestone of your project and wanted to provide a backup of your project's dependencies, run `qompoter export` to create an archive file of the `vendor` directory, or `qompoter export --repo <path to a directory>` to create a Qompotist-fs repository on which you can run `qompoter install`. You may want to use `qompoter inspect` before to check you did not modified manually any packages in the `vendor` directory.
The `qompoter install` action has been modified as follow: take the `qompoter.lock` and download dependencies. This allows to download the same version used by the last `qompoter update` without computing again the potential variadic version numbers.

Documentation
-------------
Expand Down
6 changes: 3 additions & 3 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Qompoter Roadmap
================

Version 0.5 - in progress
Version 0.5 - in progress, first release 2022, May
-----------

* [ ] Study: Make a study around `qompoter install` / `qompoter update` / `qompoter install --save` (compare with Composer, npm, yarn) and post the result into the blog
* [ ] Installation: Create Debian package (?)
* [x] Study: Make a study around `qompoter install` / `qompoter update` / `qompoter install --save` (compare with Composer, npm, yarn) and post the result into the blog. See FAQ.
* [ ] Installation: Create Debian package (in progress)
* [ ] Installation: Create Ubuntu/Snap package (?)
* [ ] Installation: Create FlatPack package (?)
* [ ] Feature: Support `--save --dev` option in `qompoter require <packagename>`
Expand Down
3 changes: 2 additions & 1 deletion changelogs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Qompoter Changelogs
===================

[Unreleased]
[0.5.0]
-------

### Breaking changes
Expand All @@ -12,6 +12,7 @@ Qompoter Changelogs
### Fixed

* KDE projects loaded from Inqlude are now using GitLab
* Now compatible with Busybox based Linux system like Alpine

### Added

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "qompoter",
"version": "0.5.0-RC1",
"version": "0.5.0",
"description": "Dependency manager for Qt / C++",
"homepage": "https://fylhan.github.com/qompoter",
"author": "Fylhan (http://fylhan.la-bnbox.fr)",
Expand Down
2 changes: 1 addition & 1 deletion qompoter.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

readonly C_PROGNAME=$(basename $0)
readonly C_PROGVERSION="v0.5.0-RC1"
readonly C_PROGVERSION="v0.5.0"
readonly C_ARGS="$@"
C_OK="\e[1;32m"
C_FAIL="\e[1;31m"
Expand Down

0 comments on commit 7051634

Please sign in to comment.