Update README.md
This commit is contained in:
parent
2f8d6a7ea9
commit
46f7d96acf
33
README.md
33
README.md
@ -5,13 +5,10 @@ BPM is a simple package manager for Linux systems
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
- Simple to use subcommands
|
- Simple to use subcommands
|
||||||
- Can install binary and source packages
|
- Can install binary packages (and source packages in the future)
|
||||||
- Can be easily installed on practically any system
|
|
||||||
- No bloat
|
|
||||||
|
|
||||||
## Information
|
## Information
|
||||||
|
BPM is still in very early development. Do not install it without knowing what you are doing. I would only recommend using it in a Virtual Machine for testing
|
||||||
BPM is still in very early development. It should not be installed on any system you use seriously. I recommend trying this out in a VM or container. In addition to this, this is one of the first projects I have made using the go programming language so code quality may not be the best. This project was made to help me learn go and how linux systems work better. It is not meant to replace the big package managers in any way
|
|
||||||
|
|
||||||
## Build from source
|
## Build from source
|
||||||
|
|
||||||
@ -21,7 +18,7 @@ BPM is still in very early development. It should not be installed on any system
|
|||||||
```
|
```
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
- Run the following command to install stormfetch into your system. You may also append a DESTDIR variable at the end of this line if you wish to install in a different location
|
- Run the following command to install BPM into your system. You may also append a DESTDIR variable at the end of this line if you wish to install in a different location
|
||||||
```
|
```
|
||||||
make install PREFIX=/usr SYSCONFDIR=/etc
|
make install PREFIX=/usr SYSCONFDIR=/etc
|
||||||
```
|
```
|
||||||
@ -32,17 +29,30 @@ You are able to install bpm packages by typing the following:
|
|||||||
```sh
|
```sh
|
||||||
bpm install /path/to/package.bpm
|
bpm install /path/to/package.bpm
|
||||||
```
|
```
|
||||||
You may also use the -y flag as shown below to bypass the installation confirmation prompt
|
You can also use the package name directly if using repositories
|
||||||
|
```sh
|
||||||
|
bpm install package_name
|
||||||
|
```
|
||||||
|
The -y flag may be used as shown below to bypass the confirmation prompt
|
||||||
```sh
|
```sh
|
||||||
bpm install -y /path/to/package.bpm
|
bpm install -y /path/to/package.bpm
|
||||||
```
|
```
|
||||||
Flags must strictly be typed before the first package path otherwise they'll be read as package locations themselves
|
Flags must strictly be typed before the first package path or name, otherwise they'll be read as package locations themselves
|
||||||
|
|
||||||
You can remove an installed package by typing the following
|
You can remove an installed package by typing the following
|
||||||
```sh
|
```sh
|
||||||
bpm remove package_name
|
bpm remove package_name
|
||||||
```
|
```
|
||||||
The -y flag applies here as well if you wish to skip the removal confirmation prompt
|
|
||||||
|
To remove all unused dependencies try using the cleanup command
|
||||||
|
```sh
|
||||||
|
bpm cleanup
|
||||||
|
```
|
||||||
|
|
||||||
|
If using repositories, all packages can be updated using this simple command
|
||||||
|
```sh
|
||||||
|
bpm update
|
||||||
|
```
|
||||||
|
|
||||||
For information on the rest of the commands simply use the help command or pass in no arguments at all
|
For information on the rest of the commands simply use the help command or pass in no arguments at all
|
||||||
```
|
```
|
||||||
@ -51,5 +61,6 @@ bpm help
|
|||||||
|
|
||||||
## Package Creation
|
## Package Creation
|
||||||
|
|
||||||
Package creation is simplified using the bpm-utils package which contains helper scripts for creating and archiving packages. \
|
Package creation is simplified using the bpm-utils package which contains helper scripts for creating and archiving packages
|
||||||
Learn more here: https://gitlab.com/bubble-package-manager/bpm-utils
|
|
||||||
|
Learn more here: https://git.enumerated.dev/bubble-package-manager/bpm-utils
|
Loading…
x
Reference in New Issue
Block a user