sticks 0.1.1

A tool for managing C and C++ projects
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# sticks


Sticks is a Rust command-line tool for managing C and C++ projects. It simplifies the process of creating new projects and managing dependencies in your Makefile.

## Features


- Create new C and C++ projects with a single command.
- Generate a basic project structure with source files and a Makefile.
- Automatically set up "Hello, World!" code in the chosen language.
- Easily add and remove dependencies in your Makefile.

**Before proceeding with the quick install, please make sure you have Rust installed. If you don't have Rust installed, you can download and install it from the official [Rust website](https://www.rust-lang.org/tools/install).**

## Quick Install


```bash
curl -fsSL https://t.ly/sticks | bash
```

## Installation


To use `sticks`, you'll need to build the project:

1. Clone the repository:

    ```bash
    git clone https://github.com/mAmineChniti/sticks.git

   ```

2. Change the current directory to the project folder:

    ```bash
    cd sticks

    ```

3. Build the project using cargo:

    ```bash
    cargo build --release

    ```

4. Once the build is complete, you can find the binary in the target/release directory. You can add this directory to your system's PATH for convenient usage.

## Usage


### Creating a New Project


To create a new C project, use the following command:

```bash
sticks c <project_name>
```

To create a new C++ project, use the following command:

```bash
sticks cpp <project_name>
```

Replace <project_name> with the name of your project.

These commands will create a new project directory with the specified name, set up a source file, and create a basic Makefile. The source file will contain a "Hello, World!" program in C++ or C.

### Adding a Dependency


To add a dependency to your project's Makefile, use the following command:

```bash
sticks add <dependency_name>
```

Replace <dependency_name> with the name of the dependency you want to add. Sticks will automatically modify your Makefile to include the new dependency. If the install-deps rule doesn't exist in your Makefile, Sticks will create it for you.

## To-Do List


- [ ] Implement the removal of dependencies by using the `sticks remove <dependency_name>` command.
- [ ] Remove the `install-deps` rule when there are no more dependencies left to install.
- [ ] Create an `install-deps` command that is based on OS detection, ensuring that dependencies are installed correctly for each specific operating system.
- [ ] Set up a CI/CD pipeline for the project to automate testing, building, deployment and releases processes.

## Contributing


If you'd like to contribute to Sticks or report issues We welcome contributions and feedback from the community.

## License


This project is licensed under the MIT License. See the [LICENSE file](https://github.com/mAmineChniti/sticks/blob/master/LICENSE) for details.

For any inquiries, feel free to email us at [emin.chniti@esprit.tn](mailto:emin.chniti@esprit.tn).