CHANGEME_DESC

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • 💡 Features
   • 🎥 Video showcase
   • 🍔 Built with
   • The stock libraries and these awesome third-party party ones
2. 🏁 Getting Started
   • 🏃 Running the Program
   • 🪟 Windows
   • Portable EXE
   • Installer
   • 🐧 Linux
   • Portable Bin
   • AppImage
   • AUR
   • Nix File
   • Deb File
   • Arch Pkg File
   • 🍎 MacOS
   • Portable Bin
   • App Folder
   • DMG Installer
   • Homebrew
   • 🚉 All Platforms
   • 🛠 Compilation
3. 🪧 Usage
   • Basics
   • Advanced
4. 🗾 Road Map
5. 💁 Contributing
6. ❓ FAQ
7. 📟 Semver
8. 🔰 Security
9. 🪪 License
10. 📧 Contact
11. 📄 Template
12. 🦾 Acknowledgments

🪽 About The Project

CHANGEME_MANUAL

If you've got any questions please give the FAQ a check.

(back to top)

💡 Features

• CHANGEME_MANUAL...

(back to top)

🎥 Video showcase

Showcase

(back to top)

🍔 Built with

• Rust 1.69.0

(back to top)

The stock libraries and these awesome third-party ones

• CHANGEME_MANUAL

(back to top)

🏁 Getting Started

🏃 Running The Program

Platform	Versions
Windows	7 and above
Linux	Anything really
MacOS	10.15 and above
All Platforms	All the above

(back to top)

---

🪟 Windows

• Portable EXE
• Installer

Portable EXE

1. Go to the Releases Tab and download the CHANGEME_BIN-windows.exe file (might have to click show all).
2. Double click the exe you just downloaded and there you go the program works.
3. Might wanna take a look at the Usage Tab if you don't understand something about it.
4. Also you might wanna make a desktop shortcut and one to place in the start-menu

Installer

1. Go to the Releases Tab and download the CHANGEME_BIN-windows-installer.exe file (might have to click show all).
2. Double click the installer and go through it as you would with any other installer.
3. 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.
4. Might wanna take a look at the Usage Tab if you don't understand something about it.

(back to top)

---

🐧 Linux

• Portable Bin
• AppImage
• AUR
• Nix File
• Deb File

(back to top)

Portable Bin

1. Go to the Releases Tab and download the CHANGEME_BIN-linux file.
2. Double click the bin you just downloaded and there you go the program works.
3. Might wanna take a look at the Usage Tab if you don't understand something about it.
4. 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 and download the CHANGEME_BIN-linux.AppImage file.
2. Double click the AppImage you download and there you go the program just works. You may want to install 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.
3. Might wanna take a look at the Usage Tab 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 or yay, which you should)

1. Just like with any other AUR pkg choose your prefered type and you can run the following command for example.

   paru -Sy CHANGEME_BIN

2. Search for CHANGEME_NAME in your app launcher and launch it.

3. Might wanna take a look at the Usage Tab 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:

   sudo pacman -Sy gcc base-devel --needed

2. Then clone the build script

   git clone https://aur.archlinux.org/CHANGEME_BIN.git # or CHANGEME_BIN-bin & CHANGEME_BIN-git

3. Cd into the new cloned repository and run the following to build the package

   makepkg

4. In order to install the package run the following (where * is just an any other characters place holder)

   sudo pacman -U CHANGEME_BIN-*.pkg.tar.zst

Nix File

1. Go to the Releases Tab and download the CHANGEME_BIN-linux.nix file.
2. 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.
3. Might wanna take a look at the Usage Tab 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 and download the CHANGEME_BIN-linux.deb file.

2. Open a terminal in the folder where your download is and run the following command:

   sudo dpkg -i CHANGEME_BIN-linux.deb

3. Run CHANGEME_BIN in the terminal and there it is, the app.

4. Might wanna take a look at the Usage Tab if you don't understand something about it.

5. 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.

(back to top)

---

🍎 macOS

• Portable binary
• App Folder
• DMG Installer
• Homebrew

(back to top)

Portable binary

1. Go to the Releases Tab and download the CHANGEME_BIN-macos file.
2. Double click the bin you just downloaded and there you go the program works.
3. Might wanna take a look at the Usage Tab if you don't understand something about it.
4. Also you might wanna place it somewhere special and create a shortuct

App Folder

Damn simillar to portable binary, only real difference is this has an icon.

1. Go to the Releases Tab and download the CHANGEME_BIN-macos-app.tar.gz file.

2. Use your archive manager or run in the terminal the following command:

   tar -xzf CHANGEME_BIN-macos-app.tar.gz

3. Double clikc the app folder you just downloaded and there you go the program works.

4. Might wanna take a look at the Usage Tab 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 and download the CHANGEME_BIN-macos-installer.dmg file.
2. Double click to run the dmg.
3. Drag the app folder over the Applications folder.
4. Done, you've just installed the app, should see it in launchpad now.
5. Might wanna take a look at the Usage Tab 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, it's really easy.

1. You will need to have homebrew installed, if you don't have it installed run the following command:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. You'll need to add my tap repository, run the following command for that:

   brew tap CHANGEME_USER/tap

3. Install the pkg.

   brew install CHANGEME_BIN

4. Might wanna take a look at the Usage Tab if you don't understand something about it.

(back to top)

---

🚉 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 or any pkg manager you may use. (There is also a shell.nix and a flake.nix in the repository if you use nix)

2. Run the following command in your terminal of choice:

   cargo install CHANGEME_BIN

3. 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)

   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 for how to add something to path. The cargo bin folder will be Users\{your-user}\.cargo\bin

4. You may want to create a symlink on Linux & macOS or create a shortcut if you are on Windows to the bin file for easy access.

5. In order to update run the install command again, and you can now follow usage for more information on how to use it.

6. Also you might wanna create a shortcut and place it in the start-menu acording to your platform.

(back to top)

---

🛠 Compilation

This program only uses cross platform libraries. The following steps require that you have rust installed, check their official installation page 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:

   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

2. 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:

   cd the/path

   and you will get there.

3. From there run this compile command in the terminal:

   cargo build --release

   It will take a bit depending on your system because of executable speed optimizations, but be patient.

4. Done, navigate to target/release and grab only the "CHANGEME_BIN" file from there.

(back to top)

🪧 Usage

In the provided video 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

(back to top)

🗾 Road Map

The roadmap (kanban board) is located up top in the projects tab or at this link.

(back to top)

💁 Contributing

Contributions are always welcome!

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md, but to generalise it the basic process is: edit a file you want, do 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.

(back to top)

❓FAQ

CHANGEME_MANUAL

1. Question 1
   • Answer 1

(back to top)

📟 Semver

CHANGEME_NAME is following Semantic Versioning 2.0.

(back to top)

🔰 Security

If you happen to find any issues please carefully read SECURITY.md and strictly follow everything stated.

(back to top)

🪪 License

Is under MIT so stick to the license conditions and have fun :)

(back to top)

📧 Contact

Either post an issue in the Issues Tab or contact me at this email address if you have more to say: CHANGEME_SMAIL

(back to top)

📄 Template

This repository is based on this template Obscurely/RustTemplate

🦾 Acknowledgments

• Best README template indeed
• This Rust project template
• This other Rust project template
• This general GitHub project template
• This site full of the best Rust tools
• Shields.io

(back to top)