Tired of searching how to start a project in a specified language? Welcome!

Find a file

Mylloon 2f2c4b7ff4 add advanced example		2024-02-01 15:15:25 +01:00
c	use pragma instead of headers	2023-11-26 00:12:41 +01:00
cpp	use pragma instead of headers	2023-11-26 00:12:41 +01:00
latex	add advanced example	2024-02-01 15:15:25 +01:00
ocaml	Add VSCode directory	2023-09-19 16:11:36 +02:00
python	Add Python	2023-09-19 16:30:22 +02:00
rust	Add Rust	2023-09-19 16:17:33 +02:00
typescript	Add Typescript	2023-09-07 17:09:24 +02:00
README.md	use pragma instead of headers	2023-11-26 00:12:41 +01:00

README.md

Init projects!

C
C++
LaTeX
- Document
- Presentation
Python
OCaml
Rust
Typescript

C

Copy and paste c/ directory, and you should be good to go!

Remember to change executable's name and change std's target in the Makefile.
Run make to compile the program.
Run make dev to compile the program in debug mode.
Run make clean to clean artifacts.

C++

Copy and paste cpp/ directory, and you should be good to go!

Remember to change executable's name and change std's target in the Makefile.
Run make to compile the program.
Run make dev to compile the program in debug mode.
Run make clean to clean artifacts.

LaTeX

Document

Copy and paste latex/document directory, and you should be good to go!

Run make to compile the document.
Run make clean to clean artifacts.

It is by default configured to output document.pdf.

Presentation

Copy and paste latex/presentation directory, and you should be good to go!

Run make updatepackage to download/update dependencie (projektor).
Run make to compile the document.
Run make clean to clean artifacts.

It is by default configured to output slides.pdf.

Python

Copy and paste python/ directory, and you should be good to go!

Run python main.py to start the program.

It's recommended to use virtual environnement:

virtualenv . → create the virtual env in the current folder

activate → activate the virtual env

Now, it won't affect your other projects

OCaml

Copy and paste ocaml/ directory, and you should be good to go!

Remember to change values in the dune-project.
Run dune exec example to run the program.
Run dune runtest to run tests.

Example of custom repository source:
(source
 (uri https://dev.example.com/project.git))

Rust

Copy and paste rust/ directory, and you should be good to go!

Remember to change values in the Cargo.toml.
Run cargo run to run the program.

Typescript

Copy and paste typescript/ directory, and you should be good to go!

Remember to change values in the package.json.
Then, to install all the dependencies, run npm install.
To check if there is any new update for dependencies, run npm outdated, makes changes accordingly to run the latest version, you may need to run npm update to apply the updates after the modification of package.json.
Run npm run main to start the program.

Contribution? Yes, please!