Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #94

Merged
merged 1 commit into from
Dec 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 58 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,87 @@
<p align="center">
<img width="250px" src="https://github.com/frate-dev/frate/blob/main/source/images/fratelogo.svg" align="center" alt="GitHub Readme Stats" />
<h2 align="center">Frate</h2>
<p align="center">This command line application came to fruition out of the desperate hopes and dreams of a few people looking to softly lighten their suffering while using c++. </p>
<a href="https://discord.gg/k7n9QnAk6N">
<img src="https://img.shields.io/discord/1173670333925036063?logo=discord"
alt="chat on Discord"></a>
<a href="https://github.com/frate-dev/frate/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/frate-dev/frate" /></a>
<a href="https://github.com/frate-dev/frate/pulse" alt="Main Activity">
<img src="https://img.shields.io/github/commit-activity/m/frate-dev/frate" /></a>
<img src="https://img.shields.io/badge/made%20with-cpp-blue.svg" alt="made with C++">
</p>


<p align="center"> <img width="250px" src="https://github.com/frate-dev/frate/blob/main/source/images/fratelogo.svg" align="center" alt="Frate Logo" /> <h2 align="center">🌟 Frate 🌟</h2> <p align="center"><i>"Easing the C++ development experience and modernizing C++ tool management"</i></p> </p>

# THIS PROJECT IS STILL IN ALPHA DEVELOPMENT, STUFF MAY BREAK
* * * * *

### 🌐 Project Status: ALPHA

# STAR THE REPO
🔧 Note: We're still fine-tuning Frate. Expect breaking changes pre alpha.

![](./source/images/average_cpp_learner.png)
🚀 About Frate
--------------

Frate is a command-line application born from the collective aspiration of making C++ development more like rust. Previously there wasn't a good default experience for C++, we aim to change that by simplifying the project initialization step and giving an overall **sane default configuration**

## Built with
- tears
- sadness
- neovim
- vscode
* * * * *

## Build the binary from source
🤝 Your C++ Companion
---------------------

### Prerequisites
Frate is more than a tool; it's your ally in the C++ world. Here's what we've achieved:

- 🚀 Easy project initialization
- 📦 Streamlined dependency management
- 📜 Simplified license handling
- 🔨 Multi-mode builds with modal dependency management
- 🌉 Cross-compilation support
- 📈 Project Blueprinting
- ☁️ Remote builds
- ⚙️ Extensible JSON configuration
- 🔄 Legacy project conversion (Coming Soon)
- 📐 Template Override (Comming Soon)

```
gcc >= 13
and
cmake >= 3
```
💡 Why Frate?
-------------

### Basic Usage
- 🚀 Easy project creation & maintenance
- 🛠️ Simple, extendable default configurations
- 📦 Unify C++ development tools like cargo, npm, or yarn
- 🌐 Decentralized package management
- ✨ Say goodbye to manually editing CMakeLists.txt

```bash
frate new #optional -d for defaults
# ... Prompts you for information about your project

frate build #optional -j <number> for multi threaded builds
* * * * *

frate run # runs the project
🛠️ Built With
--------------

frate add p <package-name> #optional -l for latest package
- 🩸Blood
- 💦Sweat
- 😭Tears

frate search p <query> #Searchs local cache for packages
* * * * *

frate update index #updates the package index

frate clean #optional -c to also clean the cache

frate watch #watches the project for changes and automatically builds and runs

```

![](./source/images/frate.png)

### Installation
### 🚀 Quick Start

#### Basic Commands
```bash
git clone https://github.com/frate-dev/frate.git
cd frate
cmake -DCMAKE_BUILD_TYPE=Release ./
sudo make install
🚀 frate new #Start a new project, -d for defaults
🛠️ frate build #Build your project, -j <number> for multi-threading
🏃‍♂️ frate run #Run the project
📦 frate add p <package-name> #Add a package, -l for latest version
🔍 frate search p <query> #Search local cache for packages
🔄 frate update index #Update package index
🧹 frate clean #Clean your project, -c to also clear cache
👀 frate watch #Auto-build and run on file changes`
```
### Installation(TBA)

### Why use Frate

- Easy project creation and maintenance
- Simple default configurations that are easy to extend
- Get the functionality of utilities like cargo, npm , or yarn and use a language you're already familiar with
- Dencentralized package management
- NEVER touch a CMakeLists.txt again
* * * * *

### ⭐️ Support Us

### Your friend in the world of C/C++
Love Frate? Give us a star on our GitHub repo!

frate is a command line utility used to expedite building modern c/c++ applications.

- [x] Easy project initialization
- [x] Easy dependency management
- [x] Easy license management
- [x] Multi mode builds
- [x] Modal dependency management
- [x] Cross compilation
- [x] Project Blueprinting
- [x] Remote builds
- [ ] Legacy project conversion
- [ ] Extensible json configuration
Loading