Skip to content

Commit

Permalink
Add the readme file to use it as the long description for this system…
Browse files Browse the repository at this point in the history
… package
  • Loading branch information
vladpunko committed Jul 7, 2021
1 parent bb809e5 commit 9a17457
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# detach-process

Spawn a new process and detach it from the current interactive session.

![usage-example](https://raw.githubusercontent.com/vladpunko/detach-process/master/detach.gif)

## Installation

Make sure the installed [gcc](https://gcc.gnu.org/install) compilers work without errors on the current operating system. To install this package as a standalone application with the command-line interface you are to run the following command:

```bash
sudo sh -c "$(curl https://raw.githubusercontent.com/vladpunko/detach-process/master/install.sh)"
```

You can also install this system package on your working machine (works for unix-like operating systems) from source code to `/usr/local/bin` as the standard system location for user's programs (this location can be changed at the user's discretion):

```bash
# Step -- 1.
git clone --depth=1 --branch=master https://github.com/vladpunko/detach-process.git

# Step -- 2.
cd ./detach-process/

# Step -- 3.
gcc -Wall -Wextra -Werror -Wno-unused-parameter detach.c -o detach

# Step -- 4.
sudo install -m 755 detach /usr/local/bin/detach
```

## Basic usage

Using this program allows you to create a new detached process avoiding complex shell pipelines in the current interactive session. It protects you from the trouble of closing an application which is the parent process of a different program.

```bash
detach ping -c 10 google.com # pgrep ping | xargs ps -p
```

## Contributing

Pull requests are welcome.
Please open an issue first to discuss what should be changed.

Please make sure this system package works without errors.

```bash
# Step -- 1.
python3 -m venv .venv && source ./.venv/bin/activate && pip install cpplint pre-commit

# Step -- 2.
pre-commit install --config .githooks.yml

# Step -- 3.
cpplint detach.c
```

## License

[MIT](https://choosealicense.com/licenses/mit)

0 comments on commit 9a17457

Please sign in to comment.