Skip to content

ragagno/neutronium-rust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

Neutronium

Neutronium is a project template.

Table of Contents

About the project

Neutronium Screenshot

This repository is a template for a project using the Rust programming language. It contains a hello world program, readme, license and other files that you would want in any project.

Getting started

To get started with this project, decide where you will place your local repository and follow these simple steps.

Prerequisites

You need to have a working git installation, a JVM and the Rust compiler.

Installation

  1. Clone this repository
    git clone https://gitlab.com/ragagno/neutronium-rust.git
  2. Rename the directory
  3. Edit the files README.md, CHANGELOG.md, LICENSE... and .gitignore depending on if you build a library or a binary
  4. Start working on your project

Usage

I recommend that you develop your project in Rust Rover as it is the best Rust IDE there is.

If you prefer basic text editors like JetBrains Fleet or Visual Studio Code, you can compile the project using the following commands.

cargo build

Roadmap

See the open issues for a list of feature requests and known problems.

Contributing

Contributions are the backbone of the open source community and are greatly appreciated. You can contribute in several manners.

The first one is to propose a pull request to the project for improving its features directly.

The second one is to open an issue when you encounter a bug or have a feature request.

The third one is to financially support the development of the project. If you feel like it, you can buy me a coffee on Ko-Fi.

License

Copyright (c) 2023-present Ragagno

Distributed under the MIT License. See LICENSE.txt for more information.

Note that this project is not actually under any license, and this part serves only as a placeholder for your license.

I recommend the MIT License or the GNU AGPL. If you want more choices, GitHub made a website that compares common licenses.

Contact

Ragagno - @ragocraft - ragocraft@gmail.com

Project Link: https://gitlab.com/ragagno/neutronium-rust

Acknowledgments

This project would not have been possible without Markdown and JetBrains Fleet.

A special thanks to the contributor of the project:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages