https://github.com/mulh8377/vset

project setup and configuration tool for V projects --
https://github.com/mulh8377/vset

make project-management-system project-structure shell vlang vset

Last synced: 3 months ago
JSON representation

project setup and configuration tool for V projects --

• Host: GitHub
• URL: https://github.com/mulh8377/vset
• Owner: mulh8377
• Created: 2019-12-05T13:46:48.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-07T16:14:26.000Z (almost 5 years ago)
• Last Synced: 2024-04-23T16:38:11.858Z (7 months ago)
• Topics: make, project-management-system, project-structure, shell, vlang, vset
• Language: Shell
• Size: 52.7 KB
• Stars: 19
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-v - vset - A project setup and configuration tool for V projects. (Applications / Project management)

README

        
# vset -- simple tool for setting up consistent projects for V

## Design Requirements

    - extendable and consistent

    - high stage build/compile/run performance

    - consistent stage build/compile/run logging

    - automate stage build/compile/run documentation

## useful build commands

    - make

        - build **working**

            * makes a consistent directory layout, stores a copy/backup src in bin/backup/

            * deletes original .git repo and initializes a new one

        - compile **modify!**

            * compiles v files in src/main

	- backup **working**

	    * backs up src/ and data/ and docs/ to bin/

	- git-init **in-progress**

	    * sets up .git directory inside of project and removes old one.

        - git-pull **working**

            * pulls v files from master branch

        - git-push **working**

            * pushes v files in src/main

        - clean **working**

            * cleans temporary files from bin/ and log/

        - kill **working**

            * resets the project back to its basic form

	- create-doc **working**

	    * creates template for .md files and stores it inside doc/todo/

	- save-doc **working**

	    * saves a backup of doc/todo/ files inside of log/temp/doc and doc/

	- create-template **working**

	    * creates template for .v files and stores it inside src/

	- clean-template **working**

	    * delete the template after you have renamed and modified the temp.v file

 	- data-clean **working**

	    * deletes all data stored in the directory.

	 - vb-mc **in-progress**

	    * a batch move and compile command. still needs some modifications

## automated project structure

    - bin/

        - /backups/ temporary storage for a src and data backups

        - /temp/ temporary files are stored here (including backups of past documentation)

        - /exec/ copies of executable binary files

        - /sh/ copies only safe and batch from vsh/shell/

    - doc/

        - stores .md & .txt generated modules and tests

    - data/

	- /csv/

	- /json/

	- /xml/

    - log/

        - /temp/ temporary storage for logging output from building, running, and cleaning

        - /temp/doc temporary storage for documents that are being saved and modified.

    - src/

        - modules and tests and code and executables are developed here.

    - vsh/

	 - shell/

		- vbatch/ shell scripts that enable batch moving and compiling of the src/ directory. 

		- vdang/ **CAREFUL** shell scripts that clean, destroy, or create a new project.

		- vgit/  shell scripts that can automate your interaction with github

		- vmake/ shell scripts that can make file templates for .md and .v

		- vsafe/ shell scripts that backup, compile, log, and run

    - Makefile

    - README.md