https://github.com/stepchowfun/stem-cell
A simple project to demonstrate the cross-platform release management process I use for my open source work.
https://github.com/stepchowfun/stem-cell
Last synced: over 1 year ago
JSON representation
A simple project to demonstrate the cross-platform release management process I use for my open source work.
- Host: GitHub
- URL: https://github.com/stepchowfun/stem-cell
- Owner: stepchowfun
- License: other
- Created: 2021-06-20T22:23:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T05:16:27.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T21:48:54.898Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 110 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Stem Cell
[](https://github.com/stepchowfun/stem-cell/actions?query=branch%3Amain)
This is a simple project to demonstrate the cross-platform release management process I use for my open source work. The program itself just prints `Hello, World!`.
This repository can be used as a starting point for a new project. Follow these instructions:
1. Rename all references to `Stem Cell` and `stem-cell` accordingly.
2. Reset the version (e.g., to `0.0.0`) in `[file:Cargo.toml]` and `[file:install.sh]`.
3. Run `cargo build` to update the version in `[file:Cargo.lock]`.
4. Delete the entries in `[file:CHANGELOG.md]` except the one about the initial version.
5. Follow the instructions in `[file:MAINTAINERS.md]` to configure the repository on GitHub.
## Installation instructions
### Installation on macOS or Linux (AArch64 or x86-64)
If you're running macOS or Linux (AArch64 or x86-64), you can install Stem Cell with this command:
```sh
curl https://raw.githubusercontent.com/stepchowfun/stem-cell/main/install.sh -LSfs | sh
```
The same command can be used again to update to the latest version.
The installation script supports the following optional environment variables:
- `VERSION=x.y.z` (defaults to the latest version)
- `PREFIX=/path/to/install` (defaults to `/usr/local/bin`)
For example, the following will install Stem Cell into the working directory:
```sh
curl https://raw.githubusercontent.com/stepchowfun/stem-cell/main/install.sh -LSfs | PREFIX=. sh
```
If you prefer not to use this installation method, you can download the binary from the [releases page](https://github.com/stepchowfun/stem-cell/releases), make it executable (e.g., with `chmod`), and place it in some directory in your [`PATH`](https://en.wikipedia.org/wiki/PATH_\(variable\)) (e.g., `/usr/local/bin`).
### Installation on Windows (AArch64 or x86-64)
If you're running Windows (AArch64 or x86-64), download the latest binary from the [releases page](https://github.com/stepchowfun/stem-cell/releases) and rename it to `stem-cell` (or `stem-cell.exe` if you have file extensions visible). Create a directory called `Stem Cell` in your `%PROGRAMFILES%` directory (e.g., `C:\Program Files\Stem Cell`), and place the renamed binary in there. Then, in the "Advanced" tab of the "System Properties" section of Control Panel, click on "Environment Variables..." and add the full path to the new `Stem Cell` directory to the `PATH` variable under "System variables". Note that the `Program Files` directory might have a different name if Windows is configured for a language other than English.
To update an existing installation, simply replace the existing binary.
### Installation with Cargo
If you have [Cargo](https://doc.rust-lang.org/cargo/), you can install Stem Cell as follows:
```sh
cargo install stem-cell
```
You can run that command with `--force` to update an existing installation.