Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 2.88 KB

README.md

File metadata and controls

92 lines (55 loc) · 2.88 KB
Raw

42projectGen

Generates a project folder with subfolders using your assets. It asks you the name of the project and generates the folder with that name.

The folder/subfolder format is this ->

ProjectName/assets/

ProjectName/headers/

ProjectName/src/

ProjectName/author*

When it generates the author file it uses the environmental variable USER.

Assets

If you want to generate project with your own files (like libraries) put them to the folder /assets/ in the executable

The program takes the files in the assets directory and sorts them.

Sorting :

*.c files -> src/

*.h files -> headers/

other files -> assets/

Bugs

Don't even mention it. I am not handling half of the errors I should currently. I am working on it.

Source Structure

It ain't pretty to look at yet... keyword yet

Also I do not have 50 years of experience in C# so if you find something that could be done better I am down to change it!

How to use

If you want to run executable just go into the folder /Executable and run the ./generator

The first time you run it it will generate a config.json file that you can change to your hearts content.

The program also has an option to delete the already generated project but it will delete everything in the folder If you want to disable this feature you can do so in config.json file by setting the delete:true to delete:false

Config

`"RuleName": default_value'

'"delete": true' allowes the deletion of the project.
'"AuthorOn": true' allowes the creation of the author file.
'"AssetsOn": true' allowes the creation of the assets directory and sorting files into it.
'"HeadersOn": true' allowes the creation of the header directory.
'"UseTemplateHeader": true' allowes creation of the header file using the `template.h` file. Works only when
`HeadersPregen` is true

'"SrcOn": true' allowes the creation of source directory.
'"SrcPregen": true' allowes the creation the source file.
'"HeadersPregen": true' allowes the creation the headers file.
'"assets": "./assets/"' Path to assets folder. Useful only if `"AssetsOn"` is true
'"output_path": "../../"' Path for the new project directory.

Source

If you would like to try fixing or even working the source file is there.

If you are planing on working on any of the lab's machines you will need to install brew

For instructions about brew slack marvin !brew

Openssl

dotnet_install_script

Here is the command I used for the dotnet_install

sh dotnet-install.sh --channel Current --install-dir ~/.brew/opt/
cd ~/.brew/bin
ln -s ~/.brew/opt/dotnet/dotnet dotnet

With this your dotnet will be installed all you need to do is open your IDE of choise (Mine is Visual Studio Code with C# ext) and program!

Here is the link to the dotnet api