Skip to content

Commit

Permalink
README: split out build instructions and add FAQs
Browse files Browse the repository at this point in the history
  • Loading branch information
lazka committed Nov 13, 2022
1 parent 10a4d08 commit e3ead38
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
16 changes: 16 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Build Instructions

```bash
# Run in a MINGW64 environment
./make-msys2-installer
```

## New Release TODO List

* Trigger a new nightly build via https://github.com/msys2/msys2-installer/actions/workflows/build.yml or use an existing one
* Get all files with dates in their names, sign them and create checksum files (.sig and .sha256)
* Create a new git tag following format: `date -I`
* Upload the installer files to the release tag
* Update the download link and checksum for the GiHub action and verify that all tests pass: https://github.com/msys2/setup-msys2/blob/master/main.js
* Run `msys2-devtools/update-installer "$(date -I)"` on the server to copy the release from GitHub
* Update the link, name and checksum on the main website (pointing to GitHub): https://github.com/msys2/msys2.github.io/blob/source/web/index.md
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,14 @@ Installing the self extracting archive to `C:\msys64`:
.\msys2-base-x86_64-latest.sfx.exe -y -oC:\
```

## Build Instructions
## FAQ

```bash
# Run in a MSYS2 environment
./make-msys2-installer
```
### What's the difference between the installer and the archives?

The installer provides some additional features such as installing shortcuts, registering an uninstaller, a GUI for selecting the installation path and automatically running a login shell at the end to initialize the MSYS2 environment.

If you unpack the archives and run a login shell once, you will get a functionally equivalent MSYS2 installation.

## New Release TODO List
### What is contained in the installer/archives?

* Trigger a new nightly build via https://github.com/msys2/msys2-installer/actions/workflows/build.yml or use an existing one
* Get all files with dates in their names, sign them and create checksum files (.sig and .sha256)
* Create a new git tag following format: `date -I`
* Upload the installer files to the release tag
* Update the download link and checksum for the GiHub action and verify that all tests pass: https://github.com/msys2/setup-msys2/blob/master/main.js
* Run `msys2-devtools/update-installer "$(date -I)"` on the server to copy the release from GitHub
* Update the link, name and checksum on the main website (pointing to GitHub): https://github.com/msys2/msys2.github.io/blob/source/web/index.md
It contains the [base](https://packages.msys2.org/package/base) package and all its dependencies. You can list the contained packages using: `pactree base -lu | sort`

1 comment on commit e3ead38

@goyalyashpal
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README: split out build instructions and add FAQs

nice.

Please sign in to comment.