my-env/README.md

95 lines
2.2 KiB
Markdown
Raw Normal View History

# My Ubuntu environment
`make`-ready bunch of scripts for easily installation of different software.
## Requirements
2022-01-08 06:07:53 +00:00
2022-07-05 02:53:41 +00:00
* Ubuntu >= 20.04 (not tested with version < 20)
2022-08-25 14:33:02 +00:00
* `bash`, `zsh` or other POSIX-compatible shell
* `make` (optional but recommended)
* `wget` (necessary for some scripts)
* `git` (necessary for some scripts)
2022-01-08 06:07:53 +00:00
2022-07-05 02:53:41 +00:00
If some dependecies are missed for some of these scripts it is enougth to run `./install/apt` in most cases.
## Usage
2022-01-08 06:07:53 +00:00
### Clone this repo (recommended)
```shell
# if git is installed
git clone git@git.axenov.dev:anthony/my-env.git --depth=1
# if git is not installed
wget -qO - https://git.axenov.dev/anthony/my-env/archive/master.tar.gz | tar -zxf -
# switch to repo dir
cd my-env
2022-01-08 06:07:53 +00:00
2022-07-05 02:53:41 +00:00
# generate fresh ./Makefile and get full list of `make` goals
./gen-makefile
# get full list of `make` goals
2022-08-19 13:26:09 +00:00
make
```
### Selective straightforward installation
2022-01-08 06:07:53 +00:00
```shell
2022-09-30 07:46:34 +00:00
# from remote file (you can meet interaction bugs this way!)
2022-07-05 02:53:41 +00:00
wget -qO - https://git.axenov.dev/anthony/my-env/raw/branch/master/install/apt | bash
2022-09-30 07:46:34 +00:00
# from locally cloned repo (except scripts from ./packs)
2022-07-05 02:53:41 +00:00
./install/apt
2022-01-08 06:07:53 +00:00
```
2022-08-26 00:25:55 +00:00
## How to add my script?
2022-01-08 06:07:53 +00:00
2022-08-26 00:25:55 +00:00
1. Create a new shell script in `./install`, `./upgrade` or `./uninstall` directory.
At the beggining of a file you must write these two lines:
```shell
#!/bin/bash
##makedesc: Your description for Makefile
```
2022-08-26 00:25:55 +00:00
2. Make this script executable, e.g.:
```shell
sudo chmod a+x ./install/myscript
```
3. Test your script
4. Run `make self` to generate new `./Makefile`
2022-01-08 06:07:53 +00:00
2022-09-30 07:46:34 +00:00
## How to create a pack?
2022-07-04 11:34:00 +00:00
You can create new file inside `./packs` dir.
2022-09-30 07:46:34 +00:00
Syntax is same as classic makefile.
It is important to add a comment with short description:
2022-07-04 11:34:00 +00:00
```makefile
2022-08-25 14:33:02 +00:00
# Pack description
2022-07-04 11:34:00 +00:00
mypack1: goal1 goal2 goalX ...
...
2022-08-25 14:33:02 +00:00
# Pack description
2022-08-19 13:26:09 +00:00
mypackX: goalA goalB
2022-07-04 11:34:00 +00:00
@cp file1 file2
...
...
```
where:
* `mypack*` is the pack name
* `goal*` are script names in `./install`
2022-07-04 15:25:31 +00:00
2022-07-05 02:53:41 +00:00
## TODO
* build: [flameshot](https://github.com/flameshot-org/flameshot#compilation)
* build: [rustdesk](https://github.com/rustdesk/rustdesk#build)
* [JB mono](https://www.jetbrains.com/ru-ru/lp/mono/#how-to-install) ([2](https://fonts.google.com/specimen/JetBrains+Mono))
* update scripts (when possible)
* uninstall scripts (when possible)
2022-07-04 15:53:39 +00:00
## License
[WTFPLv2](LICENSE)