Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/obscurely/rusttemplate
A fully setup github repository for cross-platform Rust projects. Includes scripts to automatically replace things like repository name and images, CI & CD pipelines to deploy on any platform in multiple formats asap and the best Rust practices.
https://github.com/obscurely/rusttemplate
automated cross-platform crossplatform rust-lang template template-project template-repository
Last synced: about 2 months ago
JSON representation
A fully setup github repository for cross-platform Rust projects. Includes scripts to automatically replace things like repository name and images, CI & CD pipelines to deploy on any platform in multiple formats asap and the best Rust practices.
- Host: GitHub
- URL: https://github.com/obscurely/rusttemplate
- Owner: Obscurely
- License: mit
- Created: 2023-06-02T10:56:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-29T16:21:01.000Z (8 months ago)
- Last Synced: 2024-04-29T17:38:55.445Z (8 months ago)
- Topics: automated, cross-platform, crossplatform, rust-lang, template, template-project, template-repository
- Language: Python
- Homepage: https://obscurely.github.io/RustTemplate/
- Size: 539 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Crates.io][crates-shield]][crates-url]
Table of Contents
-
About The Project
-
🏁 Getting Started
-
🪧 Usage
- 🗾 Road Map
- 💁 Contributing
- ❓ FAQ
- 📟 Semver
- 🔰 Security
- 🪪 License
- 📧 Contact
- 📄 Template
- 🦾 Acknowledgments
## 🪽 About The Project
CHANGEME_MANUAL
If you've got any questions please give the [FAQ](#faq) a check.
### 💡 Features
- [x] CHANGEME_MANUAL...
### 🎥 Video showcase
[Showcase](CHANGEME_MANUAL)
### 🍔 Built with
- [Rust 1.69.0](https://www.rust-lang.org/)
#### The stock libraries and these awesome third-party ones
- CHANGEME_MANUAL
## 🏁 Getting Started
### 🏃 Running The Program
| Platform | Versions |
| :------------------------------- | :-------------- |
| [Windows](#-windows) | 7 and above |
| [Linux](#-linux) | Anything really |
| [MacOS](#-macos) | 10.15 and above |
| [All Platforms](#-all-platforms) | All the above |
---
### 🪟 Windows
- [Portable EXE](#portable-exe)
- [Installer](#installer)
#### Portable EXE
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-windows.exe_ file (might have to click show all).
1. Double click the exe you just downloaded and there you go the program works.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
1. Also you might wanna make a desktop shortcut and one to place in the
[start-menu](https://www.windowscentral.com/add-app-shortcuts-start-menu-manually-windows-10)
#### Installer
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-windows-installer.exe_ file (might have to click
show all).
1. Double click the installer and go through it as you would with any other
installer.
1. If you look now in the start menu (or on the desktop if you ticked create
desktop shortcut) you are gonna see a shortcut for CHANGEME_NAME, just run it
like any other program.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
---
### 🐧 Linux
- [Portable Bin](#portable-bin)
- [AppImage](#appimage)
- [AUR](#aur)
- [Nix File](#nix-file)
- [Deb File](#deb-file)
#### Portable Bin
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-linux_ file.
1. Double click the bin you just downloaded and there you go the program works.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
1. Also you might wanna download _CHANGEME_BIN-linux.tar.gz_ file instead and
extract linux/desktop/CHANGEME_NAME.desktop to
$HOME/.local/share/applications, linux/desktop/icons to
$HOME/.local/share/icons in order to have a start-menu shortcut and
CHANGEME_BIN to /usr/bin/.
#### AppImage
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-linux.AppImage_ file.
1. Double click the AppImage you download and there you go the program just
works. You may want to install
[AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) if you
don't have it already, so when you start the AppImage you'll get a prompt
asking if you want to integrate and run it and if you do so it will appear
just as if you installed it.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
#### AUR
The PKGs are:
- CHANGEME_BIN (for stable)
- CHANGEME_BIN-bin (for precompiled)
- CHANGEME_BIN-git (to compile from the latest source code commit)
a. if you have an AUR manager (like
[paru](https://github.com/Morganamilo/paru/blob/master/README.md#installation)
or [yay](https://github.com/Jguer/yay/blob/next/README.md#installation), which
you should)
1. Just like with any other AUR pkg choose your prefered type and you can run
the following command for example.
```shell
paru -Sy CHANGEME_BIN
```
1. Search for CHANGEME_NAME in your app launcher and launch it.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
b. Manually cloning and building it from AUR
1. First install the basic build dependencies, if you don't already have them:
```shell
sudo pacman -Sy gcc base-devel --needed
```
1. Then clone the build script
```shell
git clone https://aur.archlinux.org/CHANGEME_BIN.git # or CHANGEME_BIN-bin & CHANGEME_BIN-git
```
1. Cd into the new cloned repository and run the following to build the package
```shell
makepkg
```
1. In order to install the package run the following (where \* is just an any
other characters place holder)
```shell
sudo pacman -U CHANGEME_BIN-*.pkg.tar.zst
```
#### Nix File
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-linux.nix_ file.
1. If you use flakes then put it in your pkgs folder, and up-top add your tag
(like _my_). If you don't just add the code in your default.nix file and
install it this way.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
#### Deb File
You should use the app image. This does not provide a desktop file, you'll have
to run it from the command-line. It's here just as another means if needed. I
will try to make a ppa eventually.
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-linux.deb_ file.
1. Open a terminal in the folder where your download is and run the following
command:
```shell
sudo dpkg -i CHANGEME_BIN-linux.deb
```
1. Run _CHANGEME_BIN_ in the terminal and there it is, the app.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
1. Also you might wanna download _CHANGEME_BIN-linux.tar.gz_ file instead and
extract linux/desktop/CHANGEME_NAME.desktop to
$HOME/.local/share/applications and linux/desktop/icons to
$HOME/.local/share/icons in order to have a start-menu shortcut.
---
### 🍎 macOS
- [Portable binary](#portable-binary)
- [App Folder](#app-folder)
- [DMG Installer](#dmg-installer)
- [Homebrew](#homebrew)
#### Portable binary
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-macos_ file.
1. Double click the bin you just downloaded and there you go the program works.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
1. Also you might wanna place it somewhere special and
[create a shortuct](https://www.lifewire.com/create-desktop-shortcuts-on-a-mac-5184827)
#### App Folder
Damn simillar to [portable binary](#portable-binary), only real difference is
this has an icon.
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-macos-app.tar.gz_ file.
1. Use your archive manager or run in the terminal the following command:
```shell
tar -xzf CHANGEME_BIN-macos-app.tar.gz
```
1. Double clikc the app folder you just downloaded and there you go the program
works.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
#### DMG Installer
Works just like any other dmg installer you've used.
1. Go to the
[Releases Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/releases) and
download the _CHANGEME_BIN-macos-installer.dmg_ file.
1. Double click to run the dmg.
1. Drag the app folder over the _Applications_ folder.
1. Done, you've just installed the app, should see it in launchpad now.
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
#### Homebrew
Note this method doesn't come with a desktop entry. You'll have to run the
_CHANGEME_BIN_ command or just
[create a shortcut yourself](https://siytek.com/macos-terminal-command-as-a-shortcut/#2.-Create-a-new-shortcut),
it's really easy.
1. You will need to have [homebrew](https://brew.sh) installed, if you don't
have it installed run the following command:
```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
1. You'll need to add my tap repository, run the following command for that:
```shell
brew tap CHANGEME_USER/tap
```
1. Install the pkg.
```shell
brew install CHANGEME_BIN
```
1. Might wanna take a look at the [Usage Tab](#-usage) if you don't understand
something about it.
---
### 🚉 All Platforms
This method will work across any Linux distribution, Windows 10/11 and macOS
(Big Sur+ tested).
1. Install rust, either using the official
[rustup installer](https://www.rust-lang.org/tools/install) or any pkg
manager you may use. (There is also a shell.nix and a flake.nix in the
repository if you use nix)
1. Run the following command in your terminal of choice:
```shell
cargo install CHANGEME_BIN
```
1. Make sure you have .cargo/bin in path, for linux and macOS you would need to
add the following line in your terminal RC file (e.g $HOME/.zshrc)
```shell
export PATH=$HOME/.cargo/bin:$PATH # This is for Linux & macOS, look below for Windows.
```
On windows it should work automatically (restart if just installed), if not
you can follow this [guide](https://www.computerhope.com/issues/ch000549.htm)
for how to add something to path. The cargo bin folder will be
Users\\{your-user}\\.cargo\\bin
1. You may want to create a
[symlink](https://www.freecodecamp.org/news/symlink-tutorial-in-linux-how-to-create-and-remove-a-symbolic-link/)
on Linux & macOS or
[create a shortcut](https://support.microsoft.com/en-us/office/create-a-desktop-shortcut-for-an-office-program-or-file-9a8df64b-cd87-4700-95cc-4bc3e2a962da)
if you are on Windows to the bin file for easy access.
1. In order to update run the install command again, and you can now follow
[usage](#-usage) for more information on how to use it.
1. Also you might wanna create a shortcut and place it in the start-menu
acording to your platform.
---
### 🛠 Compilation
This program only uses cross platform libraries. The following steps require
that you have rust installed, check their official
[installation page](https://www.rust-lang.org/tools/install) or use any pkg
manager you may want. (There is also a shell.nix and a flake.nix in the
repository if you use nix).
1. Clone this repository on your PC, you can use "git clone", if you have git
installed, like this:
```shell
git clone https://github.com/CHANGEME_USER/CHANGEME_NAME.git
```
Otherwise in the right up side of the repository page you will see a download
button, download the repository as zip and extract it in a folder
1. Open a new terminal/cmd window in the folder you extracted the repository in,
if you can't right click on the folder and open it there do:
```shell
cd the/path
```
and you will get there.
1. From there run this compile command in the terminal:
```shell
cargo build --release
```
It will take a bit depending on your system because of executable speed
optimizations, but be patient.
1. Done, navigate to target/release and grab only the "CHANGEME_BIN" file from
there.
## 🪧 Usage
**In the provided [video](#-video-showcase) it's presented everything you should
know on how to use CHANGEME_NAME. I also think the UI is intuitive enough, but I
obviously can't have an unbiased opinion or a first look experience, so here you
go.**
### Basics
CHANGEME_MANUAL
### Advanced
CHANGEME_MANUAL
## 🗾 Road Map
The roadmap (kanban board) is located up top in the projects tab or at
[this link](https://github.com/users/CHANGEME_USER/projects/CHANGEME_MANUAL).
## 💁 Contributing
Contributions are always welcome!
Please read [CONTRIBUTING.md](CONTRIBUTING.md) and
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), but to generalise it the basic process
is: edit a file you want, do a
[pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request),
I will look at it and if the change makes sense and is a good one I will accept
it and that's it. Also be kind and respectful.
## ❓FAQ
CHANGEME_MANUAL
1. Question 1
- Answer 1
## 📟 Semver
CHANGEME_NAME is following [Semantic Versioning 2.0](https://semver.org/).
## 🔰 Security
If you happen to find any issues please carefully read
[SECURITY.md](SECURITY.md) and strictly follow everything stated.
## 🪪 License
Is under [MIT](https://mit-license.org/) so stick to the license conditions and
have fun :)
## 📧 Contact
Either post an issue in the
[Issues Tab](https://github.com/CHANGEME_USER/CHANGEME_NAME/issues) or contact
me at this email address if you have more to say:
[CHANGEME_SMAIL](mailto:CHANGEME_SMAIL)
## 📄 Template
This repository is based on this template
[Obscurely/RustTemplate](https://github.com/Obscurely/RustTemplate)
## 🦾 Acknowledgments
- [Best README template indeed](https://github.com/othneildrew/Best-README-Template/blob/master/README.md)
- [This Rust project template](https://github.com/rust-github/template/tree/main/template)
- [This other Rust project template](https://github.com/vmchale/project-init)
- [This general GitHub project template](https://github.com/maehr/github-template)
- [This site full of the best Rust tools](https://blessed.rs/crates)
- [Shields.io](https://shields.io/)
[](https://ko-fi.com/K3K3H29LV)
[contributors-shield]: https://img.shields.io/github/contributors/CHANGEME_USER/CHANGEME_NAME.svg?style=for-the-badge
[contributors-url]: https://github.com/CHANGEME_USER/CHANGEME_NAME/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/CHANGEME_USER/CHANGEME_NAME.svg?style=for-the-badge
[forks-url]: https://github.com/CHANGEME_USER/CHANGEME_NAME/network/members
[stars-shield]: https://img.shields.io/github/stars/CHANGEME_USER/CHANGEME_NAME.svg?style=for-the-badge
[stars-url]: https://github.com/CHANGEME_USER/CHANGEME_NAME/stargazers
[issues-shield]: https://img.shields.io/github/issues/CHANGEME_USER/CHANGEME_NAME.svg?style=for-the-badge
[issues-url]: https://github.com/CHANGEME_USER/CHANGEME_NAME/issues
[license-shield]: https://img.shields.io/github/license/CHANGEME_USER/CHANGEME_NAME.svg?style=for-the-badge
[license-url]: https://github.com/CHANGEME_USER/CHANGEME_NAME/blob/master/LICENSE
[crates-shield]: https://img.shields.io/crates/v/CHANGEME_BIN.svg?style=for-the-badge
[crates-url]: https://crates.io/crates/CHANGEME_BIN
