HidemaruOwO/MicroRepository
Template
1
0
Fork 0
mirror of https://github.com/HidemaruOwO/MicroRepository.git synced 2025-06-28 21:52:18 +09:00
Code Issues Projects Releases Packages Wiki Activity Actions

📚 add explanation comments for each sections (README.example.md)

Browse source
This commit is contained in:
ひでまる 2025-03-14 01:30:03 +09:00
parent 9e8adf9ed1
commit 964e2720c3
1 changed files with 39 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.example.md
View file

@ -1,12 +1,20 @@
<!-- THIS README IS CREATED BY HidemaruOwO/MicroRepository -->
<!-- SEE: https://github.com/HidemaruOwO/MicroRepository -->
<!-- YOU SHOULD RUN THIS COMMAND IF YOU USING VIM --> <!-- YOU SHOULD RUN THIS COMMAND IF YOU USING VIM -->
<!-- :%s;HidemaruOwO/MyRepository;USERNAME/REPONAME;g --> <!-- :%s;HidemaruOwO/MyRepository;USERNAME/REPONAME;g -->
# MyRepository 📚 # MyRepository 📚
<!-- description -->
A template that gathers the minimal structure of my repository. A template that gathers the minimal structure of my repository.
## 🚀 Features ## 🚀 Features
<!-- write your apps features-->
<!-- This "features" section assumes a generic REST API. Please modify it to fit your software. -->
- SIMPLE REST API - SIMPLE REST API
- COOK APPLE PIE - COOK APPLE PIE
@ -16,33 +24,57 @@ A template that gathers the minimal structure of my repository.
brew install my-repository brew install my-repository
``` ```
<!-- you should active this graphs if you using package manager -->
<!-- | distribution | command | -->
<!-- | -------------------- | ------------------------------- | -->
<!-- | Ubuntu | `apt-get install <package>` | -->
<!-- | Debian | `apt install <package>` | -->
<!-- | Arch Linux | `pacman -S <package>` | -->
<!-- | Fedora | `dnf install <package>` | -->
<!-- | CentOS | `yum install <package>` | -->
<!-- | openSUSE | `zypper install <package>` | -->
<!-- | Alpine Linux | `apk add <package>` | -->
<!-- | Gentoo | `emerge <package>` | -->
<!-- | NixOS | `nix-env -iA nixpkgs.<package>` | -->
<!-- | macOS | `brew install <package>` | -->
<!-- | Windows (winget) | `winget install <package>` | -->
<!-- | Windows (Chocolatey) | `choco install <package>` | -->
### 🏗 Install from Source ### 🏗 Install from Source
```sh ```sh
git clone https://github.com/HidemaruOwO/MyRepository.git git clone https://github.com/HidemaruOwO/MyRepository.git
cd MyRepository cd MyRepository
# build command (e.g: go build, cargo build, pnpm run build)
make -j8 make -j8
install -Dm0755 -t "/usr/local/bin/" "dist/builded-binary" install -Dm0755 -t "dist/builded-binary" "/usr/local/bin/"
``` ```
- Arch Linux <!-- active there, if you have makepkg -->
```sh <!-- - Arch Linux -->
git clone https://github.com/HidemaruOwO/MyRepository.git
cd MyRepository
makepkg -si <!-- ```sh -->
``` <!-- git clone https://github.com/HidemaruOwO/MyRepository.git -->
<!-- cd MyRepository -->
<!-- makepkg -si -->
<!-- ``` -->
## 🎯 Usage ## 🎯 Usage
<!-- This "usage" section assumes a generic REST API. Please modify it to fit your software. -->
```bash ```bash
# running local host 3000 # running local host 3000
MyRepository MyRepository
``` ```
<!-- using systemd -->
- To run the service automatically, you can set it up with `systemd`: - To run the service automatically, you can set it up with `systemd`:
```sh ```sh